Understanding API Errors and Providing Effective Support
APIs/Open API-related issues are common queries that users may encounter while interacting with our systems. To provide efficient support and resolve these issues promptly, it is essential to gather detailed information. This document explains the importance of curl requests and guidelines for submitting support requests related to APIs.
Submitting a Support Request
If you encounter an API issue, please follow the guidelines below for a swift and accurate solution:
- Step 1: Right-click on the page where the API error is suspected and click on “Inspect”.
- Step 2: Click on “Network”.
- Step 3: Clear the network logs and click on the element/button throwing the error on the website.
- Step 4: Select the suspected API from the name column under the network and right-click on that API. Find and select “Copy” then click on “Copy as cURL(Bash)” for Windows and for Mac click on “Copy as cURL”.
If you are using Open APIs or any other API, please share the below-mentioned details:
- API Url
- API Request Body
- API Request Method
- Headers (if required)
- Error code
- Error Message