Overview
Welcome to the Voxtelesys Auth API — your gateway to programmatically accessing tokens needed to make requests to our resources.
OAuth 2.0
OAuth 2.0 setup can be found in the Voxtelesys Portal.
A provider must first be established by clicking Create Provider and providing the Discovery Url (if you are using Voxtelesys as your OAuth provider, you can enter https://authapi.voxtelesys.net/api/v1/.well-known/openid-configuration).
A client can then be created which will allow you to select access to Voxtelesys APIs. Using this client, JWTs (Javascript Web Tokens) can be generated. This token can then be used in the Authorization header when making requests to protected resources:
Authorization: Bearer <token>
More information on the specifics of creating JWTs with a client can be found here.
Base URL
All API endpoints are accessed through the following base URL:
https://authapi.voxtelesys.net/api/v1
All requests are served over HTTPS to ensure data privacy. Unencrypted HTTP is not supported.
Regions
The Voxtelesys Auth API is currently supported in the following regions:
| Region | ID | Base URL |
|---|---|---|
| Salt Lake City | slc | https://authapi.slc.voxtelesys.net/api/v1 |
| Dallas-Fort Worth | dfw | https://authapi.dfw.voxtelesys.net/api/v1 |
| Pittsburgh | pit | https://authapi.pit.voxtelesys.net/api/v1 |
To send a request to a specific region, use a base URL of the format https://authapi.<region>.voxtelesys.net/api/v1, where <region> is a region ID in the table above. If no region is specified in the base URL, a default region will be automatically selected.
Support
If you encounter any issues or have questions about the API, please reach out to Support. Our team is here to assist you with integration, troubleshooting, and best practices.