If you're keen on getting Streamtime to seamlessly interact with your bespoke software, you'll need to understand our API documentation and your exclusive API key.
About Swagger API
Streamtime's API docs are hosted on Swagger. Swagger presents a human-friendly interface where users can explore and understand an API. It also allows users to "try out" API calls directly from the browser, facilitating testing and understanding of API behaviour. The UI is generated from an OpenAPI Specification (OAS) file, which describes the API's structure, endpoints, parameters, responses, and authentication methods. This ensures the documentation is always in sync with the API's definition.
Check out Streamtime on Swagger here.
Step 1. Locate Your API Key
Head to Settings: Tap the ⚙️ icon and choose Integrations under Account Settings.
Grab Your Key: Scroll down to the API section and hit Connect. You will then have access to your key. Copy and paste the string.
Test the Key within Swagger's interface (that link again is here).
Once the key is obtained, enter it within the 🔓 Authorise settings page on Swagger. Now you're ready to start testing your API calls directly within the browser.
🔑 Can't locate the key? Only the account subscriber can access this key, ensuring you keep your setup snug and secure.
Rate Limits on our API
There are limits to the number of API calls that your application can make against a particular organisation in order to ensure reliability and availability:
60 requests per minute
720 requests per hour
In addition to the request limits, there are also duration limits as well to prevent against long running requests:
30 seconds of processing time per minute (2 second delay applied, request is still processed)
300 seconds of processing time per hour (429 error returned)
These limits are implemented to ensure the stability of our own application. If you're hitting them, chances are there is a more efficient way to make the calls! Reach out to help@streamtime.net if you are seeing rate limiting errors.