Getting Started
Introduction#
Our API has predictable, resource-oriented URLs and uses HTTP response codes to indicate API errors. We use built-in HTTP features, such as HTTP authentication and HTTP terminology, which can be understood by HTTP clients. JSON will be returned in all responses from the API, including errors.Requests#
Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required.The maximum API body request size is 50 MB.| Method | Usage |
|---|
| GET | Retrieve information (read-only) |
| DELETE | Destroy a resource and remove it |
| PUT | Update information about a resource |
| PATCH | Partial modification of supported resources |
| POST | Create a new object with specified attributes |
Responses#
The API uses HTTP response codes to show success or failure of an API request. In general, 2xx codes indicate success, 4xx codes indicate an error that resulted from the provided information (e.g. a required parameter is missing or invalid, etc.), and codes in the 5xx range indicate an error connected with our servers.HTTP Statuses#
Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes.In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered.| Code | Description |
|---|
| 2xx | OK — Request has been completed successfully. |
| 400 | Bad Request — Required parameter is missing. |
| 401 | Unauthorized — Provided credentials are invalid or your API token has expired. |
| 403 | Forbidden — Access denied. You do not have enough rights. |
| 404 | Not Found — Requested item doesn't exist. |
| 429 | Too Many Requests — You have exceeded the number of allowed requests for your resources. |
| 503 | Service Unavailable — You have made a mistake in request parameters or the service is currently unavailable. |
| 500, 502, 504 | Server errors — Something went wrong on our end. |
Authentication#
In order to interact with the Gotipath Stream API, you need to have a registered account. Sign up if you don't have one.The majority of methods require an API X-Auth-ClientId, X-Auth-LibraryId, X-Auth-ApiKey in the Request header. These are unique keys that all users and applications should add to requests in order to interact with our services.| Field | Description |
|---|
| X-Auth-ClientId | Get Client ID from your stream library |
| X-Auth-LibraryId | Get Library ID from your stream Library |
| X-Auth-ApiKey | Get API Key from your stream library |
📌
Rate limit
The general limit is set at 60 requests per second. If you exceed this rate limit, you will receive a notification. If any special requirements necessitate a higher rate limit, please reach out to our support team for assistance.
Modified at 2023-11-22 13:09:24
