API Authentication
Orbitype exposes a full-featured RESTful API that you can connect to from your
own code. Read, create, update, and delete items with simple HTTP requests.
Table of contents:
First steps
To get started, go to your project's settings page and generate a new API key.
Each key is scoped to exactly one connector. Make sure to include it in each
request as a custom
X-API-KEYheader. Sending an
HTTP OPTIONSrequest to the API
base URL will return the IDs of the project and connector the key is scoped
to.
Authentication Headers
Make sure to include the API key in your requests as a custom header:
X-API-KEY: your-key-hereYou can verify your key’s scope by sending an OPTIONS request:
http request OPTIONS https://core.orbitype.com/api X-API-KEY: your-key-hereThe response will contain the project and connector IDs:
{
"projectId": "your-project-uuid",
"connectorId": "your-connector-uuid"
}