API reference
Responses and errors
Every response uses the same envelope. Check the HTTP status first, then the body.
The envelope
{
"message": "License verified successfully",
"code": "00",
"success": true,
"data": { }
}successboolean- True for 2xx responses.
codestring00on success,01on error.messagestring- A short summary, such as
NOT_FOUNDon errors. Don’t match on its wording; it can change. dataobject | null- The result on success; null on error.
errorobject | null- On error,
detailsexplains what went wrong.
Status codes
| Status | Meaning | What to do |
|---|---|---|
| 200 | It worked. | Use data. |
| 400 | The request is malformed or a value is invalid. | Fix the request; don't retry as is. |
| 401 | Missing, revoked or expired secret key. | Check the key and its environment. |
| 402 | Not enough credits. | Ask the user to top up; don't retry. |
| 403 | Not allowed, for example a frozen wallet. | Don't retry. |
| 404 | The licence, app user key or wallet wasn't found for your organisation. | Treat as not entitled. |
| 409 | Already exists, for example a reused idempotency key. | Treat a usage retry as recorded. |
| 500 | Something failed on Ploba's side. | Retry with backoff, reusing the same idempotency key. |