API Keys

Programmatic acess to the OrbitSailor API is authenticated by API keys scoped to your customer account.

Each key has a limited scope of actions that you are able to perform with it, and you are able to revoke it at any time.

Scopes

At the moment, four scopes are available:

Query Service Status:
This scope enables you to call the service Status endpoint /api/ServicesStatuses to get information about the current state of your deliveries
Archive Access
Keys with this scope authorize you to call all endpoints associated with the Archive API to retrieve historical AIS data.
Modify Vessel Lists
Keys with this scope authorize you to call endpoints starting wih /api/VesselList on the Vessel list API to retrieve and modify your stored vessel lists.
For more information on Vessel management in OrbitSailor, see Vessel management
Change Service Configurations
Keys with this scope authorize you to call endpoints in the Service configuration api starting with /api/v2/serviceconfigurations as well as the HTTP Pull sign endpoint to programmatically manage your data services.