What is the API Console?
API Console allows developers to select the API they need to debug, enter the corresponding API key and request parameters. The Console reduces development costs and helps developers quickly get started and complete development.
What Does It Look Like?
Take the Member Information Query API debugging as an example.
How to Set the API Console?
Step 1 Entering the Setting Page
1. Via Parameter Reference
To directly debug the API, go to Parameter Reference and click API Console.
2. Via API Document
You can go to the API Console through the API document.
Step 2 Select API
In APIs on the left, select the API that needs to be debugged. For example, select the Member Information Query API.
Step 3 Set Request Header
After selecting the API, set:
• Authorization: enter the API key of Jodoo. You can create and copy the API key in Open Platform > API Key.
• Server address: the server address called by the API.
Step 4 Set Request Body
Modify the required parameters in the request body to debug the API. For example, in the Member Information Query API, the parameter "username" needs to be replaced with the member ID (No.) to be queried. You can find the member ID (No.) in Contacts.
Step 5 View Debugging Result
After setting Request Header and Request Body, click the RUN button to view the debugging results. See the Preview section.
When to Use the API Console?
Developers can send requests, view responses, and adjust parameters based on API information during the development process:
• Using the console to test different endpoints and functionality of the API ensures that the API works as expected, parameters are passed correctly, and responses are as expected;
• Developers can easily adjust request parameters to see how different inputs affect the API, thus finding the best configuration;
• Viewing detailed error information helps locate and solve problems quickly.
I have finished reading. 🏆
👉I can't wait to SET API CONSOLE.
👉I need more HELP in Discord Forum.