HTTP Transport

Base URL

https://api.ocelloids.net

Open API Specification

https://api.ocelloids.net/openapi.json

API Docs UI

https://api.ocelloids.net/api-docs

Authorization

To use the Ocelloids Services, you will need an API key, check how to get access

The HTTP API uses the bearer authentication scheme.

To authenticate an API request include your API key in the Authorization HTTP header.

The header should be formatted as follows:

Authorization: Bearer <YOUR_API_KEY>

Example Authenticated Request

Here is an example of how to include the Bearer token in an API request using curl:

curl \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H 'content-type: application/json' \
-H 'accept: application/json" \
https://api.ocelloids.net/

Errors

The error payload is a JSON object according to the following schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "boolean"
    },
    "statusCode": {
      "type": "integer"
    },
    "reason": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "statusCode",
    "reason"
  ]
}

Error Codes