|
<< Click to Display Table of Contents >> Navigation: Support > Scopos REST API |
Version 2.21.3.2Scopos maintains a series of REST APIs, allowing external users to access our data and interact with Orion and Athena programmatically.
The Public API allows access to:
•Match data and scores that the owner has marked as Publicly available. Basically, the same data that is available on the Result Center.
•Reconfigurable Rulebook definition files.
•Add or edit Orion's registration data, shot data, and virtual matches (coming soon).
The Authenticated API requires Scopos account (email and password, previously known as a Orion mobile account) access, and allows users to access:
•Their personal match data and scores.
The Internal API is for Scopos use only and requires log in credentials to access.
Scopos Labs is a publicly available git repository with example projects using our REST API. Examples include both python and c-sharp code using our BabelFish nuget library.
An X API Key is required to access all of our REST APIs. The key is added to the header of the request, with key value "x-api-key".
Example X API Key: GyaHV300my60rs2ylKug5aUgFnYBj6GrU6V1WE33
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.
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 six months.
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.
Individuals or companies who wish to interact with the REST API for application development may purchase an annual X API Key license. Contact us for pricing and usage plans.