Getting Started

Copy page

Getting Started with the Reelyze Developer API

Reelyze's Developer APIs are a set of RESTful APIs designed to provide a simple way to interact with the platform.

Authentication

Our APIs use API Keys as Bearer tokens for authentication. You should ensure the following header is provided for all requests:

Code
 
Authorization: Bearer YOUR_KEY_HERE

Base URL

The base URL for all requests should be:

Code
 
https://developer-api.reelyze.com/v2/

Versioning

Our API is versioned, and the version must be supplied the route for all calls

The Developer API currently supports API version 2

Additional versions will be added as and when any breaking changes are made to the API. Older versions may be removed over time, but we will notify customers of any deprecations and allow sufficient time for any code to be migrated.

Extensibility

All of our response contracts are extensible - there may be additional properties on any response which are not listed in the documentation and therefore you should ensure your response parsing allows additional properties to be present.

Making Requests

Our APIs use standard HTTP methods (GET, POST, PUT, PATCH, DELETE). You can call the API with any HTTP client, for example

Code
 
curl -X GET "https://developer-api.reeylze.com/v2/users" -H "Authorization: Bearer YOUR_API_KEY"

Content Types

All APIs are JSON based, no other content types are supported. You should ensure the following headers are included on your requests:

Code
 
Accept: application/json
Content-Type: application/json

Responses

Our APIs use HTTP response codes to indicate the status of your request. Our standard responses include

• 200 OK
• 201 Created
• 204 No Content
• 400 Bad Request
• 401 Not Authenticated (bad / missing token)
• 403 Not Authorised (no access to requested API)
• 404 Resource Not Found
• 429 Too Many Requests (see Rate Limits)
• 500 Internal Server Error

See Standard Responses for details on standard responses