Overview
When calling API endpoints from Postman or your application, you may encounter issues related to authentication, headers, or request formatting.
This guide lists common problems and their solutions so you can quickly diagnose and resolve them.
Authentication issues π
Symptom:
You receive an error such as:
401 Unauthorized
403 Forbidden
How to fix:
β Ensure you have created a valid application key in the Developer Portal.
β Add the key to the request header:
Key | Value |
---|---|
X-API-KEY | your API key |
β If you are using environment variables in Postman (e.g., ``), double-check that the variable is set and selected in the current environment.
β If you deleted or rotated your key, generate a new one and update it everywhere itβs used.
Missing or incorrect headers π
Symptom:
The request fails, or you receive an unexpected response (e.g., 400 Bad Request
).
How to fix:
β Confirm the X-API-KEY
header is present.
β Make sure there are no typos in the header name or value.
β Check that the Content-Type
header is set appropriately (e.g., application/json
for JSON requests).
Expired or invalid tokens (if applicable) β³
Symptom:
You receive 401 Unauthorized
even though your API key or token was working earlier.
How to fix:
β If the API requires short-lived tokens, refresh or regenerate them.
β In Postman, re-run the authentication request (if applicable) to fetch a new token.
β In your application, implement token refresh logic to avoid downtime.
Common HTTP errors and fixes β οΈ
Error Code | Meaning | Possible Fix |
---|---|---|
400 | Bad Request | Check query parameters, request body, and header formatting. |
401 | Unauthorized | Verify API key, tokens, and authentication headers. |
403 | Forbidden | Ensure your key has permission to access the endpoint. |
404 | Not Found | Check that you are calling the correct endpoint and URL path. |
429 | Too Many Requests | You may have hit rate limits. Wait and try again later. |
500 | Internal Server Error | Retry after a few seconds. If it persists, contact support. |
Common pitfalls π§°
β Using the wrong environment:
Make sure you are calling the correct environment (sandbox vs. production).
β Forgetting to save headers:
In Postman, save the header and parameter setup in a collection to avoid re-entering every time.
β Incorrect base URL:
Double-check that your `` variable or endpoint URL is correct and has no trailing slashes or typos.
β Calling endpoints without parameters:
Some endpoints require query parameters (e.g., centreCode
, zoneId
). Missing parameters may return empty results.
β Using an expired key:
If you deleted or rotated the key, older requests will fail until updated.
Need help? π
If issues persist after troubleshooting:
β Refer to the Quick start guides.
β Check the API activity log in the Developer Portal for clues (e.g., failed request counts).
β Contact the support team with the error message, request details, and timestamp for faster resolution.