Navigate Through the Documentation (How to Browse & Test)

This guide shows you how to navigate the documentation site, switch between sandbox and production environments, authenticate your requests, and test API calls directly from the browser using the built-in API Explorer.

Documentation structure

The documentation is organized into three main sections accessible from the top navigation:

SectionWhat you find there
GuidesConceptual documentation, onboarding tutorials, workflows, and best practices
API ReferenceEvery endpoint with interactive "Try It" console, parameters, examples, and response schemas
ChangelogRecent API changes, new features, and deprecation notices

Quick start: make your first API call from the browser

  1. Press Cmd+K (Mac) or Ctrl+K (Windows/Linux) to open the search bar and find any endpoint
  2. Select the Environment (Sandbox or Production) at the top of the endpoint page
  3. Paste your Bearer Token in the Authorization panel
  4. Use the Examples dropdown to prefill a request with sample data
  5. Click Send to execute the request
  6. Review the Response panel for status code, JSON body, and headers

Understanding an endpoint page

Every endpoint page follows a consistent layout:

SectionDescription
Title and Method/PathThe endpoint name with its HTTP method and URL path (e.g., POST /ship/rate/)
DescriptionWhat the endpoint does and when to use it
Environment selectorSwitch between Sandbox (api-test.envia.com) and Production (api.envia.com)
AuthorizationEnter your Bearer token for authentication
Parameters and Request BodyFill in path parameters, query parameters, and the JSON request body
ExamplesPre-built request templates for common scenarios
Code SamplesReady-to-copy snippets in cURL, JavaScript, Python, and more
Try It consoleExecute the API call directly from your browser
ResponsesExpected status codes, sample response bodies, and JSON schemas

Selecting your environment

Use the Environment dropdown at the top of any endpoint page to switch between:

  • Sandbox (Test): https://api-test.envia.com/ — safe environment for development and testing. No real charges or labels.
  • Production: https://api.envia.com/ — live environment that generates real labels and charges your account.

The base URL updates automatically when you switch environments. Always verify you are 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 documentation site. It applies to all endpoints automatically.
  • Per-request token — Expand the Authorization section on a specific endpoint and paste your token there. This overrides the global token for that request.

Use separate tokens for Sandbox and Production. Generate tokens in your Envia dashboard under Desarrolladores → Acceso de API. See Authentication for details.

Using pre-built examples

Each endpoint includes an Examples dropdown with pre-configured request bodies for common scenarios. Select one to prefill the Try It form with valid data. This is the fastest way to test an endpoint without writing any code.

Tips for effective testing

  • Use Cmd+K / Ctrl+K to search for endpoints by name or description
  • Open multiple endpoint pages in separate browser tabs to compare requests and responses
  • Start testing in the Sandbox environment before switching to Production
  • Check the response Headers tab for rate limit information and request IDs
  • If you get a 401 Unauthorized, verify that your token matches the selected environment (sandbox tokens do not work with production URLs)
  • If you get a 422 Unprocessable Entity, check the error message for which field is missing or invalid
  • For 429 Too Many Requests, wait a few seconds and retry

Tip: The API Explorer sends real requests to the Envia API. In the Sandbox environment, this is completely safe. In Production, requests will generate real labels and charges — use caution.

What to read next

  • Ready to integrate? Follow the Integration Guide for a step-by-step walkthrough of all three APIs.
  • First API call? The Quickstart ships a sandbox package in 3 API calls.
  • Need a token? Set up your credentials with the Authentication guide.

🛟

Need Help?

Have questions or need assistance with your integration?
Our support team is ready to help 🚀

Create a support ticket here and we’ll guide you with setup, troubleshooting, or feature requests.