API Requests

All requests will have a common structure and specific parameters. The response codes can be found at the following link: Response Codes.

All requests will have a common structure and specific parameters. The format is as follows:

Body

• Key (string): Identifier of the sender.
• Nonce (string): Unique identifier for the request, used to control data duplication.
• Mode (enum[string]): Signing algorithm.
  • sha256
  • sha512
• Resource (string): Identifier of the resource.
• Payload (object): Contains the specific parameters for each request.

Headers

• Content-signature: Contains the signature of the request body (Body) with the private key. HMAC(body, secret, mode)
• Content-type: It is important to note that the API will only process requests with the content type application/json.

Example

{
    "key": "589365da65c48cff87d0874a",
    "nonce": "1234567890",
    "mode": "sha256",
    "resource": "359ef8ce5c5f4003b71692e446908c27",
    "payload": {
        "param1": "value1",
        "param2": "value2"
    }
}