Orbitas API

Orbitas API 3.4.8

Welcome to the Orbitas API, a powerful toolset that enables clients and partners to integrate their collection and inspection work flows directly into their own solutions. This documentation walks through the API’s latest endpoints. Bookmark this page, as the Orbitas API team will regularly add new endpoints and functionalities for your organization’s benefit.

Orbitas APIs are crafted around REST and the REST architectural style to provide developers with a stateless and language-agnostic interface. The Orbitas API leverages HTTP verbs and response codes, 2-Step authorization, and resource-oriented URIs.

Authorization

The Orbitas API uses a 2-step protocol to authorize users. All API requests require authorization and utilize the HTTP Authorization header.

Both the login and authentication requests should be made using the GET HTTP method.

Step 1 - https://api.orbitas.xyz/login

Scheme	Parameter	Header Value	Returns
Basic	Base64("{{Username}}:{{Password}}")	`Basic Base64("{{Username}}:{{Password}}")`	`{ "id": "{{UserId}}", "key": "{{ApiKey}}" }`

Step 2 - https://api.orbitas.xyz/authentication

Scheme	Parameter	Header Value	Returns
dataorbit_auth	Base64("{{ApiKey}}:{{UserId}}")	`dataorbit_auth Base64("{{ApiKey}}:{{UserId}}")`	`{ "accessKey": "{{ApiAccessKey}}", "expiry": "{{Timestamp}}", "userRole": "{{Authenticated User's default role}}" }`

All Subsequent Requests

Scheme	Parameter	Header Value
dataorbit_api	Base64("{{ApiKey}}:{{ApiAccessKey}}")	`dataorbit_api Base64("{{ApiKey}}:{{ApiAccessKey}}")`

Requests

The Orbitas API uses standard HTTP verbs and query, path and body parameters to facilitate API functions.

Currently, the API only supports JSON. All POST / PUT requests require a valid JSON object for the request body.

All requests should be routed to the host url: https://api.orbitas.xyz

Accepted HTTP Verbs
Name	Uses
GET	Retrieve a resource or list of resources.
POST	Create a new resource.
PUT	Update an existing resource.
DELETE	Delete an existing resource.

Resource Parameters
Location	Explanation
query	Found at the end of a URI following the '?' character, these parameters are used to filter resources or provide contextual data for specific API functions. Concatenate multiple query parameters with the '&' character. ex: https://api.orbitas.xyz/jobs?keyword=monument&limit=8
path	Placed directly in the path of a URI, these parameters are typically used to specify a particular resource. ex: https://api.orbitas.xyz/jobs/{{JobId}}
body	Attached to the request body, these parameters provide values used to create or update a resource.

Errors

The Orbitas API leverages standard HTTP response status codes for it’s error responses. Error codes are:

Code	Message	Description
400	Bad Request	The request was malformed or provided incorrect and / or incomplete. Check the response for more detailed messaging about why the request was incorrect. Do not repeat request.
401	Unauthorized	The API does not recognize the request as authorized. API access token may be missing or invalid.
403	Forbidden	The API recognizes the authorized API user, but the API user does not have correct permissions to satisfy the request.
404	Not Found	The resource requested does not exist or was not found.
409	Conflict	The request violates data constraints. Check the response for more detailed messaging about what constraints were violated.
415	Unsupported Media Type	The request contains a file type that the server was not expecting. This error will only be seen when uploading files through the API.
500	Server Error	The request was valid, but something failed on the server. Additional messages may be available.

Operations

The following is a list of operations available through the Orbitas API.