Sendbox API Documentation
  • Introduction
  • API
    • Basics
    • Errors
  • Authentication
    • Authentication
  • Shipping
    • Introduction
    • Get Shipments
    • Get Shipment
    • Request Shipping Quotes
    • Create New Shipment
    • Calculate Landed Cost
    • Tracking Shipment
    • Saved Addresses
  • Payment
    • Introduction
    • Payment Profile
    • Virtual Account
  • third party intergations
    • WooCommerce Plugin
    • Opencart Extension
    • Shopify
    • Magento
  • Webhooks
    • WooCommerce
  • Webhooks
    • WooCommerce
Powered by GitBook
On this page
  • Introduction
  • Getting Started
  • Create a New Application
  • Authorization
  • Making API Requests
  • Permanent Tokens

Was this helpful?

  1. Authentication

Authentication

PreviousErrorsNextIntroduction

Last updated 5 months ago

Was this helpful?

Introduction

This document provides guidelines on how to authenticate your application with the Sendbox API. This updated version includes streamlined authentication processes and reflects recent changes to the API.

Getting Started

To integrate with the Sendbox API, you'll need to create an application and obtain an access token, which will be used for all subsequent API requests. Here's how to get started:

It is important to note that all development and testing are done on staging. Once completed, remember to update the production URL and follow all the same steps.

Environment

Developer Dashboard URL

Base URL

Staging

Production

Create a New Application

  1. Sign Up: Visit and sign up for an account if you haven’t already.

  2. Dashboard: After signing in, navigate to your dashboard and create a new application. You will need to provide the following details:

    • Name: The name of your application.

    • Description: A brief description of what your application does.

    • Webhook URL: The URL where Sendbox will send event notifications for your application.

    After submitting this information, your application will be created successfully. Keep your application keys in a safe place as they will be required for making API requests.

Authorization

Once your application is created, you'll be issued an access token. This token is crucial for authorizing API requests.

  • Access Token: The access token is used to authenticate your application. It should be included in the header of every API request.

Making API Requests

To interact with the Sendbox API, include your access token in the header of your HTTP requests as shown below:

GET /your/api/endpoint
Host: live.sendbox.co
Authorization: {your-access-token}
  • Authorization Header: The header must include the Authorization key, followed by your access token.

Permanent Tokens

Please note that access tokens are now permanent and do not expire. There is no need to handle token refresh mechanisms.

https://developers.sendbox.co/
Sendbox for Developers
https://developers.staging.sendbox.co/
https://sandbox.staging.sendbox.co/
https://developers.sendbox.co/
https://live.sendbox.co/