The Ausha API is based on REST principles, and provides JSON metadata about your podcasts shows and its related content,
such as episodes, playlists, statistics & more. This API is only accessible to Ausha's customers.
The base address of the API is https://developers.ausha.co. The API provides a set of endpoints, each with its own
unique path. To have access to these endpoints, you'll have to authenticate your requests.
Authentication process is detailed below.
Rate Limiting enables the Ausha API to share access bandwidth to its resources equally across all users. It limits the
number of requests a user can make in a certain amount of time.
If the web api responds with a 429 status code, it means that you have sent too many requests. When this happens, check the
Retry-After header of the response, where you will see a number displayed. This is the number of seconds that
you need to wait, before you can request the API again.
Every request you make to the Ausha API needs to be authenticated. To do so, we use the Authorization
header, in which
you need to put an access token, like the example below :
curl --request GET --url https://developers.ausha.co/v1/podcasts/$PODCAST_ID --header 'accept: application/json' --header 'content-type: application/json' --header 'Authorization: Bearer $ACCESS_TOKEN'
You can obtain an access token in your Ausha manager. Go to your user parameters (arrow next to your name, top-right corner, then 'My account'), and go to the section 'Public API'. In this page, you can manage your tokens and generate new ones. Be careful, tokens are only shown once at generation.
Code | Description |
---|---|
200 | OK - The request has succeeded. The client can read the result of the request in the body and the headers of the response. |
201 | Created - The request has been fulfilled and resulted in a new resource being created. |
204 | No Content - The request has succeeded but returns no message body. Often returned after a DELETE operation. |
401 | Unauthorized - The request requires user authentication or, if the request included authorization credentials, authorization has been refused for those credentials. |
422 | Unprocessable entity - The data provided by the request to update or create an object is not valid. |
429 | Too Many Requests - Rate limiting has been applied. |
500 | Internal Server Error. This should not happen, but if it does, please contact us |
If you need help or if you want to report a mistake in the documentation, feel free to contact our support through the communication bubble in the bottom-right corner of your Ausha manager.