Skip to content

Commit 47d170f

Browse files
committed
fixed headers, added more details
1 parent f06040e commit 47d170f

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

docs/troubleshooting/api/client-server_errors_during_the_api_call.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ This guide will help you understand the most common API error codes and how to f
1212

1313
To learn more about APIs, check out our **[API documentation guide](/resources/backend-logic/rest-api/)**.
1414

15-
## Common client-side status codes
15+
## Common Client-Side Status Codes
1616

1717
These errors are usually caused by incorrect requests from the client side.
1818

19-
- **400 – Bad request**
19+
- **400 – Bad Request**
2020

21-
Your request isn’t properly formatted. This could be due to a missing parameter, a typo, or incorrect syntax.
21+
The 400 error is a generic response indicating that the server could not understand the request due to malformed syntax. Common causes include incorrect query parameters or missing fields in the request body. Ensure your request is correctly formatted and all required information is included.
2222

2323
:::tip
2424
Check the API's own documentation to ensure you're including the correct fields and headers.
@@ -28,65 +28,65 @@ These errors are usually caused by incorrect requests from the client side.
2828

2929
- **401 – Unauthorized**
3030

31-
You didn’t provide the correct credentials (like an API key). Most APIs require authentication via headers.
31+
This status code appears when authentication has not yet been provided. To resolve this, ensure you have signed up for the API and included your API key in the HTTP header of your request.
3232

3333
![401 Example](../assets/20250430121350799148.png)
3434

3535
- **403 – Forbidden**
36-
37-
You’re authenticated, but you don’t have permission to access the resource. This could be due to API plan restrictions or role-based access.
36+
37+
Receiving a 403 error means you're authenticated but do not have permission to access the requested resource. This could be due to using the wrong API key or attempting to access features not available in your subscription plan.
3838

3939
![403 Example](../assets/20250430121351077308.png)
4040

41-
- **404 – Not found**
41+
- **404 – Not Found**
4242

43-
The URL you’re requesting doesn’t exist. This could be due to a typo or a deprecated API endpoint.
43+
The 404 error indicates that the requested URL does not exist on the server. This could be due to a typo in the URL or changes in the API endpoints. Always verify the URL and check for any recent API updates.
4444

4545
:::tip
4646
Always double-check your request URL before troubleshooting further.
4747
:::
4848

4949
![404 Example](../assets/20250430121350517804.png)
5050

51-
- **407 – Proxy authentication required**
51+
- **407 – Proxy Authentication Required**
5252

5353
You haven't authenticated with the proxy server. This is less common but can happen in restricted network environments.
5454

55-
- **422 – Unprocessable entity**
55+
- **422 – Unprocessable Entity**
5656

5757
Your request was well-formed but couldn’t be processed. For example, passing a `latlng` without a comma.
5858

59-
- **429 – Too many requests**
59+
- **429 – Too Many Requests**
6060

61-
You’ve hit your rate limit. Most APIs restrict the number of requests you can make in a certain timeframe.
61+
This error occurs when too many requests are sent in a short period, exceeding the API's rate limits. To avoid this, implement request throttling or review your API subscription plan to ensure it meets your needs.
6262

6363
:::tip
6464
Check your API plan limits and consider throttling requests from your app.
6565
:::
6666

67-
## Common server-side status codes
67+
## Common Server-Side Status Codes
6868

6969
These errors occur on the API server side.
7070

71-
- **500 – Internal server error**
71+
- **500 – Internal Server Error**
7272

73-
The server ran into an unexpected issue. Double-check your request, but if it looks fine, the problem is likely on the server side.
73+
A 500 error can occur for various reasons, often indicating that the API server has crashed. Check your request for accuracy and consult the API documentation for any known issues.
7474

75-
- **501 – Not implemented**
75+
- **501 – Not Implemented**
7676

77-
The HTTP method you're using (example, PUT or PATCH) isn't supported by the API yet.
77+
This error occurs when the HTTP method used in the request is not supported by the server. Trying a different HTTP method or checking the API documentation for supported methods can resolve this issue.
7878

79-
- **502 – Bad gateway**
79+
- **502 – Bad Gateway**
8080

81-
The API server is using a gateway or proxy, and it failed to get a valid response from the upstream server. Usually a temporary issue.
81+
This error means that the server, acting as a gateway or proxy, received an invalid response from the upstream server. It's usually a temporary issue that should be resolved by the API provider.
8282

83-
- **503 – Service unavailable**
83+
- **503 – Service Unavailable**
8484

85-
The API server is overloaded or undergoing maintenance. Try again later.
85+
The 503 status code indicates that the server is temporarily unable to handle the request due to overload or maintenance. Waiting before sending another request is often the best approach.
8686

87-
- **504 – Gateway timeout**
87+
- **504 – Gateway Timeout**
8888

89-
The API server took too long to respond. Try simplifying your request or reducing the size of the data being sent.
89+
A 504 error suggests that the server, acting as a gateway, did not receive a timely response from the upstream server. This could be due to network latency or the API server processing the request too slowly.
9090

9191

9292
**Troubleshooting Steps**

0 commit comments

Comments
 (0)