You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/troubleshooting/api/client-server_errors_during_the_api_call.md
+23-23Lines changed: 23 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,13 +12,13 @@ This guide will help you understand the most common API error codes and how to f
12
12
13
13
To learn more about APIs, check out our **[API documentation guide](/resources/backend-logic/rest-api/)**.
14
14
15
-
## Common client-side status codes
15
+
## Common Client-Side Status Codes
16
16
17
17
These errors are usually caused by incorrect requests from the client side.
18
18
19
-
-**400 – Bad request**
19
+
-**400 – Bad Request**
20
20
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.
22
22
23
23
:::tip
24
24
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.
28
28
29
29
-**401 – Unauthorized**
30
30
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.
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.
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.
44
44
45
45
:::tip
46
46
Always double-check your request URL before troubleshooting further.
You haven't authenticated with the proxy server. This is less common but can happen in restricted network environments.
54
54
55
-
-**422 – Unprocessable entity**
55
+
-**422 – Unprocessable Entity**
56
56
57
57
Your request was well-formed but couldn’t be processed. For example, passing a `latlng` without a comma.
58
58
59
-
-**429 – Too many requests**
59
+
-**429 – Too Many Requests**
60
60
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.
62
62
63
63
:::tip
64
64
Check your API plan limits and consider throttling requests from your app.
65
65
:::
66
66
67
-
## Common server-side status codes
67
+
## Common Server-Side Status Codes
68
68
69
69
These errors occur on the API server side.
70
70
71
-
-**500 – Internal server error**
71
+
-**500 – Internal Server Error**
72
72
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.
74
74
75
-
-**501 – Not implemented**
75
+
-**501 – Not Implemented**
76
76
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.
78
78
79
-
-**502 – Bad gateway**
79
+
-**502 – Bad Gateway**
80
80
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.
82
82
83
-
-**503 – Service unavailable**
83
+
-**503 – Service Unavailable**
84
84
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.
86
86
87
-
-**504 – Gateway timeout**
87
+
-**504 – Gateway Timeout**
88
88
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.
0 commit comments