Encrypt

Encrypts a string.

post

This is a simple encryption method and should not be used for sensitive data. The encryption 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

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

The cryptography encrypt request model.

plainTextstring · min: 1Required

The plain text to encrypt.

Responses

200

The request was successful.

application/json

429

The user has exceeded the rate limit.

application/json

post

HTTPcURLJavaScriptPython

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

{
  "plainText": "text"
}

application/jsontext/jsonapplication/*+json

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