POST
/
api
/
niobi-signature
curl --request POST \
  --url https://users.niobi.co/api/niobi-signature \
  --header 'Content-Type: application/json' \
  --data '{
  "client_id": "K1PoY1WYricSpXh6Wm24txxxxxxxxxx",
  "sender": "Niobi integration",
  "salt": "mySalt12342423",
  "params": {
    "test": 123
  }
}'
{
  "success": true,
  "message": "Signature was generated successfully.",
  "data": {
    "client_id": "<client_id>",
    "params": {},
    "salt": "<salt>",
    "sender": "<sender>",
    "timestamp": "<timestamp>",
    "signature": "<signature>"
  }
}

Body

application/json
Payload for Signature generation
client_id
string
required

Client ID generated when creating new api keys

Example:

"K1PoY1WYricSpXh6Wm24txxxxxxxxxx"

sender
string
required

the title of the integration

Example:

"Niobi integration"

salt
string
required

Salt for added security

Example:

"mySalt12342423"

params
object
required

Additional parameters for the request

Response

200
application/json
Signature was generated successfully.
success
boolean
Example:

true

message
string

Success message

Example:

"Signature was generated successfully."

data
object

The generated data including the signature

Example:
{
  "client_id": "<client_id>",
  "params": {},
  "salt": "<salt>",
  "sender": "<sender>",
  "timestamp": "<timestamp>",
  "signature": "<signature>"
}