Navigate Through the Documentation (How to Browse & Test)

Use this guide to learn how to navigate the docs, switch environments (Test/Production), add your API token, run requests from the browser, and iterate on parameters using the built ‑in API Explorer.

What’s in the Top Navigation

• Guides – conceptual docs, onboarding and best practices.
• Recipes – copy‑paste patterns for common workflows.
• API Reference – every endpoint with live "Try It" console, parameters and examples.
• Changelog – see what changed and when.
• Discussions – ask questions and see community answers.

Quick Start

1. Open Search – press ⌘K / Ctrl+K and find your endpoint.
2. Select Environment – choose Test or Production.
3. Authenticate – paste your Bearer Token in the Authorization panel (or set it globally).
4. Pick an Example – use the Examples dropdown to prefill a request.
5. Run the Request – click Send.
6. Inspect Results – view Response, Headers and Schema.
7. Iterate – tweak query/body/headers, re‑send and compare.

Understanding an Endpoint Page

Every endpoint page follows the same layout:

1. Title & Method/Path (e.g. GET /country)
2. Description – what it does and when to use it.
3. Environment selector – switch between Test and Production.
4. Authorization – add your bearer token.
5. Parameters & Request Body – fill in path, query and body fields.
6. Examples – pre‑built request templates.
7. Code Samples – snippets in cURL, JS/Node, Python and more.
8. Try It console – run the call from your browser.
9. Responses – status codes, sample bodies and schemas.

Selecting Your Environment

Use the Environment dropdown at the top of the endpoint page to switch between Test (Sandbox) and Production. The base URL updates automatically. Make sure you’re in the correct environment before sending requests.

Adding Your Bearer Token

You can authenticate in two ways:

• Global token – set your bearer token once at the top of the docs; it will apply to all endpoints.
• Per‑request token – expand the Authorization section on an endpoint and paste your token there.

Keep your tokens private; use separate tokens for Test and Production.

Using Examples

Each endpoint includes an Examples dropdown with common request bodies. Select one to prefill the Try It form; it’s great for testing happy paths or edge cases.

Running Requests & Viewing Results

1. Confirm environment and authorization.
2. Fill any required fields (path, query, body).
3. Click Send.
4. Inspect the Response panel: status code, JSON body, headers and timing.

You can modify fields and re‑run to see how results change.

Tips & Troubleshooting

• Use ⌘K / Ctrl+K to search for endpoints quickly.
• Open multiple endpoints in new tabs to compare.
• If you get a 401 Unauthorized, check your token.
• If you see a 400/422, verify required fields and data types.
• For rate limiting (429), slow down and retry after a few seconds.

Feel free to explore the Guides and Recipes for more in‑depth workflows, and refer to the API Reference for complete details on each endpoint.