Errors & Responses

Mobile App Integration Guide

HTTP Status Codes

200OK - request succeeded.
204No Content - returned for OPTIONS preflight requests (CORS).
400Bad Request - missing or invalid parameter.
401Unauthorized - token missing or invalid.
404Not Found - endpoint or resource does not exist.
405Method Not Allowed - wrong HTTP method for this endpoint.

Success Response Schema

JSON
{
  "success": true,
  "...": "endpoint-specific fields"
}

Error Response Schema

JSON
{
  "success": false,
  "message": "Human-readable error description"
}

CORS

All API responses include the following headers, so the API can be called from web clients:

HTTP
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Allow-Headers: Authorization, Content-Type, X-API-Token
*
Browsers send a preflight OPTIONS request before a cross-origin POST. The API responds with 204 No Content and the CORS headers above - no body required.