Decrypt

Decrypts a string.

post

This is a simple decryption method and should not be used for sensitive data. The decryption is not secure and should not be used for sensitive data.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

The cryptography decrypt request model.

cipherTextstring · min: 1Required

The cipher text to decrypt.

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

datastring · nullableRead-onlyOptional

This is the data to be returned to the client.

429

API call exceeded rate limit due to too many requests.

application/json

post

/api/v1/cryptographies/decrypt

HTTPcURLJavaScriptPython

POST /api/v1/cryptographies/decrypt HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "cipherText": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": "string",
  "errors": []
}