Errors
Every error of the App API is an RFC 7807 problem, application/problem+json, whose type is the address of its page here: https://dev.positive-app.fr/errors/<code>. Match on type, never on title or detail: those are for people and may change.
{
"type": "https://dev.positive-app.fr/errors/scope-missing",
"title": "Scope missing",
"status": 403,
"detail": "The installation was not granted the scope \"read_products\"."
}
| Status | Error | Title | Meaning |
|---|---|---|---|
| 400 | invalid-cursor | Invalid cursor | The pagination cursor is not valid for this installation, resource and filters. |
| 400 | invalid-parameter | Invalid parameter | A query or body parameter is missing, malformed or out of range; the detail names it. |
| 403 | forbidden-for-apps | Forbidden for apps | An installation token was sent to a route that is not part of the App API. An installed app can call /api/app/v1 only. |
| 403 | marketplace-disabled | Marketplace disabled | The marketplace is not enabled on this platform, so no app can use the App API there. |
| 403 | scope-missing | Scope missing | The installation was not granted a scope this operation needs. |
| 404 | not-found | Not found | The resource does not exist, or it belongs to an organization the installation does not cover: the API does not tell the two apart. |
| 429 | rate-limited | Too many requests | The installation exceeded its request budget. |
| 503 | marketplace-unavailable | Marketplace unavailable | The marketplace service behind the operation cannot answer right now. |
A 401 answer has no problem type of its own: the token is missing, expired or revoked, or the installation was uninstalled or suspended. Refresh the token once; if it is still refused, stop calling the API for that installation.