praniSheba API

Authentication

Every call carries your API key in the X-API-Key header.

Live and sandbox keys

Key types
KeyLooks likeWhat it does
Livepsk_ then 8 letters, then 32 moreCalls the identification model and uses tokens.
Sandboxpsk_test_ then 8 letters, then 32 moreReturns sample answers. Uses no tokens and is never logged.

Creating and revoking keys

  • Create keys on the API access page of your dashboard. The full key is shown once, so copy it then.
  • You can have up to 5 active live keys and 5 active sandbox keys. Live keys need an approved account; sandbox keys do not.
  • Revoke a key you no longer use, or one that leaked, on the same page and create a new one.

When authentication fails

No key sent (401)

Response body.

{
  "is_success": false,
  "message": "Missing API key.",
  "data": null
}

Key not recognised or revoked (403)

Response body.

{
  "is_success": false,
  "message": "Invalid API key.",
  "data": null
}
Authentication errors
StatusMeaning
401The X-API-Key header is missing.
403The API key is invalid or revoked, or your account is suspended.