Light Mode
Responses
Salla have applied all the technical standards have been placed by the REST principles. So, developers can always receive, read, decode, or understand the errors in responses based on the following form:
Color Code | Response | Status | Meaning |
---|---|---|---|
200 | Success | The request has succeeded. | |
201 | Created | API call has been accepted for processing. The sent resource has been successfully inserted/updated at our database | |
202 | Accepted | API call has been accepted for processing. This status code is used only when the sent resource has been successfully deleted from our database | |
204 | No content | The server successfully processed the request, but is not returning any content | |
:::info
With a 2xx
success response, the response body will include a status
field reflecting the HTTP status (2xx) and a success
field set to true
and , as shown in the following example:
{
"status": 200,
"success": true,
"data": {
"message": null,
"code": 200
}
}
:::
This API uses the following error codes:
With every request you might get these responses in case of any error :
Color Code | Response | Slug | Status | Meaning |
---|---|---|---|---|
400 | bad_request | Bad Request | Invalid parameters, fields or filters | |
401 | unauthorized | Unauthorized | authorization error (invalid basic auth data or API key) | |
403 | forbidden | Forbidden | The server understood the request, but is refusing it (blocked due to many errors in particular time) or the access is not allowed. | |
404 | not_found | Not Found | The specified resource/url-path could not be found | |
405 | method_not_allowed | Method Not Allowed | The method used is not allowed. | |
406 | not_acceptable | Not Acceptable | The format used is not acceptable. | |
410 | gone | Gone | The resource requested is no longer available. | |
422 | validation_failed | Unprocessible Entity | used if the server cannot process the enitity, e.g. mandatory fields are missing in the payload. | |
429 | too_many_requests | Too Many Requests | Rate limit exceeded. | |
500 | server_error | Internal Server Error | We might be updating our services, please wait a while before trying again. | |
503 | service_unavailable | Service Unavailable | We were unable to handle the HTTP request due to a temporary overloading or maintenance of the server. Please try again later. |
:::caution[Important]
In case of multiple errors resulting in a 4xx response, the response will include a list of "fields
" and an array of error messages as "values
" for those fields, explaining the errors for each field. Here is an example for reference.
:::
Last modified: 3 months ago