Using the API Console

Step 1. Refer to the API Component guides to find the correct API Console URL. Each API has its own API Console. The URL is usually generally in the format:

https://api.tablecheck.com/api/{API_NAME}/v1/docs

Step 2. Click "Authorize" and enter your API key in the pop-up dialog. Note that you may be given separate API keys for Live and Test accounts.

Step 3. Open an API endpoint by clicking on it.

Step 4. Click "Try it Out"

Step 5. Enter query parameters and click "Execute".

Caution: "Execute" will run a live command. GET requests are read-only (safe), however POST, PUT, and DELETE requests will modify or delete data according to the command.

Step 6. Scroll down to view the API response.

Step 7. Scroll further down to see response documentation. Note that you can click on both "Example Value" and "Model". "Model" has a collapsing menu which you can further click to see individual parameter descriptions.