How to Use Interactive API Reference

Before using the interactive API reference, please obtain an API key.

1. Production vs Development Features

Select the version based on the production features or development features offered by Interplai.

2.) Choose a language

3.) Enter your API key

This is typically the API key created in the Client Console. Different API keys are created for Production versus Development.

4.) Enter parameters

Necessary parameters are indicated with a red required tag. Additional parameters are grouped and may need to be accessed by expanding sections.

Expand sections to see more parameters using the + symbol.

5.) View the code sample and click on “Try it!” button

By clicking on the Try It! button, users will be able to run requests directly from the browser and view the actual API response.

6.) View Response

Responses are formatted in JSON.