Speedify for Teams API
The Speedify for Teams API is used to query information and manage user accounts in your Speedify team. The API is a RESTful API that uses HTTP requests and provides responses in a JSON format and using HTTP status codes.
Getting Started
- Once you get a Speedify for Teams account, login instructions will be emailed to you. Using those you can then login to the admin console and go to https://my.speedify.com/api
- The Speedify API uses API keys to authenticate and authorize requests. Generate one by clicking the red + button on the right side of the table
- Enter a description that will let you recognize what the key is used for and then click 'Generate Key'
- Copy the newly generated key and use it in your application to call the Speedify for Teams API. See the Authentication section for more details.
Versioning
All end points begin with a version number indicated by v1, v2, etc. New end points and non-breaking changes will be added to the API without any changes in the version number. Any breaking changes will result in a new version number. The older version will continue to be supported for an amount of time that will be determined when the new version is released.
Authentication
The Speedify for Teams API requires an api key (that you generated and copied in the Getting Started section) sent in the "x-api-key" header to authenticate requests.
This API key should be kept private; do not add the key to public repositories or in places where a non-team user might have access to it. If you suspect that a key has been leaked, you can revoke it from the admin console.
Legacy scripts that use HTTP Basic Authentication are still supported.
In the sample requests provided, the basic authentication credentials are part of the URL. You can also use the appropriate method in your language to send basic auth credentials instead of sending it as part of the URL. For example, in curl:
curl -H "x-api-key: [api-key]" url