X-API-Key

<< Click to Display Table of Contents >>

Navigation:  Support > Programmatic Access >

X-API-Key

X-API-Key

An X-API-Key is required to access all of our REST APIs and use BabelFish.

Shared Starter Key

To start accessing Scopos's REST API you may use the following API Key. However, it is rate limited, shared, and obviously open to the public.

Example X-API-Key: GyaHV300my60rs2ylKug5aUgFnYBj6GrU6V1WE33

Placement

The key is added to the header of the request, with key value "x-api-key".

Obtaining an X-API-Key

Orion for Clubs Customers

Existing Orion license customers may obtain a limited but free X-API-Key for interacting with the Public and Authenticated APIs.

These X-API-Keys are tied to a usage plan that will allow small to medium clubs to access the API at a rate consistent with a Clubs personal use but not for application development.

Personal Use

Individuals who wish to interact with the REST API for their personal use, and not for application development, may contact us for a free X-API-Key valid for twelve months.

Students Use

Students, enrolled in K-12, college, or university, who wish to interact with the REST API for their personal use, and not for application development, may contact us for a free X-API-Key valid for four years.

Application Developers

Individuals or companies who wish to interact with the REST API for application development may apply for an annual X-API-Key license. Currently Scopos is providing X-API-Key licenses for free, however we will be charging for these licenses soon. Prices have not been set but will be consistent with industry standards. You may have one X-API-Key per application. Contact us to apply.