How to Use API Reference Pages
The API Reference pages show the API syntax for each call. They also let you run the calls against your developer center applications (see How to Create a Developer Center Application). You can test and experiment with requests and view and use the response data, including error messages.
IMPORTANT: API Reference pages are available only for the following products:
Control API Groups
For groups of APIs on the page:
- Expand or collapse the group by clicking Show/Hide.
- Click Expand Operations to expand all the calls in the group.
- Click List Operations to collapse the list.
Set Credentials for all Requests
You can set credentials for all requests on the page. This populates the calls with a valid access token and the needed user data to enable the calls. The assignment only lasts while you are on the page. If you leave or refresh the page, you will need to repeat these steps.
IMPORTANT: Some calls need additional data such as a meeting or training ID. You can obtain these values from API requests on the page.
- Click Try It Out at the top of the page. User Settings displays.
Option 1: Use Your Generated Values
- If you have completed the steps to get an access token, copy the access_token value and organizer_key values and paste them into the corresponding fields.
- Click Set and Close to populate the calls on the page with the values.
Option 2: Generate New Values
- If you have created a developer application, but have not generated an access token yet, you can enter product credentials and generate one. Click Get new access token. User Settings displays.
- Enter a valid product user ID and password, and copy in your Consumer Key from your developer center application.
- Click Get Set and Close. The values populate the calls and the dialog closes.
Each request consists of Implementation Notes, Parameters, and Response Messages.
Some parameters are automatically entered when you use the Set Credentials option. You can also enter them manually, and you will need to enter any parameters that are not automatically updated such as meeting or training ID.
Parameters are in the form of “dataKey”:”dataValue”.
For POST, PUT, and PATCH calls, you can also enter the request body:
- Click in the Model Schema box that displays the body template for the call. The template is copied to the body on the request.
- Modify the data values. Make sure the quotations and other punctuation is retained.
- Click Try it out at the bottom of the request. The return response is displayed including any response data.