Skip to main content
All CollectionsOpen Platform
Parameter Reference
Parameter Reference

Introduce what is parameter reference and how to set it.

Updated this week

What is the Parameter Reference?

In Parameter Reference, you can quickly query the parameters required for API debugging by switching apps and forms. The Parameter Reference document provides developers with an integrated platform to query documents, debug APIs, and generate code samples. These features can support efficient development and review.

The Parameter Reference document allows you to switch between apps and forms, and query the parameters required for API debugging. The document also enables you to access documents, debug APIs, and generate code samples on one platform, thus leading to efficient development and review.


What Does It Look Like?

For example, on the Parameter Reference page, you can view the form and field information in the resource management system.


How to Set the Parameter Reference?

Step 1 Entering the Setting Page

To access the parameter reference details page, go to Open Platform > Guide and click Parameter Reference.

Step 2 Switching Apps

On the parameter reference details page, select different apps from the drop-down list of Switch Apps.

Step 3 Viewing Forms

1. After selecting an app, select a form on the left, and you can view the relevant information on the form. For example, App ID, Form ID, Field Name, Field ID, Field Type, and so on, to which the form belongs.

2. If there are too many fields in the form, use the search box in the upper right corner to search for the field names and view the field information.

Step 4 API Console

In API Console, select the API that needs to be debugged, enter the corresponding API key, and request parameters to debug. For details, see: API Console.

Step 5 Setting Field Alias

Click Set Field Alias to set field aliases for the fields in the form.

Note:

Field aliases can only contain lowercase letters, numbers, and underscores, and must start with lowercase letters.

Step 6 JSON Example for Fields

Click JSON Example for Fields to view the JSON code of the fields in the form. Enterprises can copy the JSON code for API debugging according to their own needs.


When to Use the Parameter Reference?

It is suitable for enterprises with certain development capabilities. You can use Parameter Reference to customize development content through APIs and connect to the Jodoo platform.

The feature is designed for companies that enjoy development capabilities, allowing them to use APIs for customized development and seamlessly integrate Jodoo with other platforms.


I have finished reading. 🏆

👉I can't wait to REFER THE PARAMETER REFERENCE.

👉I need more HELP in Discord Forum.

Did this answer your question?