BaseUrl

All API access are over HTTPS, and accessed from the {baseUrl}/api/v1 domain.
Any non-secure requests are met with a redirect (HTTP 301) to the HTTPS equivalent URI.

πŸ‘

Production

API: https://o21c.obvious21.com
Dashboard: https://dashboard.o21.io
O21Pay App: https://pay.o21.io

πŸ“˜

Sandbox

API: https://sandbox-o21c.obvious21.com
Dashboard: https://sandbox-dashboard.o21.io
O21Pay App: https://sandbox-pay.o21.io

HTTP verbs

As per RESTful design patterns, the Obvious21 API implements following HTTP verbs:

HTTP VerbDescription
POSTCreate new resource
GETRead resource
PATCHUpdate existing resource
PUTAdd resource
DELETERemove resource

HTTP Status Codes

All responses use standard HTTP status codes:

Status CodeDescription
200OK - Successful request
301Moved Permanently
400Bad Request - The request is malformed. Check the parameters or the syntax
401Unauthorized - Couldn’t authenticate the request
403Forbidden - The request is not allowed
404Not Found - Resource not found
429Too many requests - See Rate limits
500Internal Server Error

Response 2xx

Field nameType
dataObject
statusCodeInteger
{
    statusCode: 2xx,
    data: {
        ...
    }
}

Errors

Field nameType
statusCodeInteger
errorString
messageString
{
    statusCode: 401,
    error: 'Unauthorized',
    message: 'Missing secret provided'   	
}

Rate Limits

πŸ“˜

Rate limits

The limit is set according to your subscription plan, it varies between 50 and 200 reqs/min. This value can be increased according to your needs, please contact us.

PlanReqs/Min
Starter20
Advanced50
Premium100
Entreprise200

Timestamps and dates

All timestamps are returned in ISO 8601 format with time :

yyyy-MM-ddTHH:mm:ss.SSSZ

All dates are returned in format:

yyyy-MM-dd