Authentication

Before you can start using the Shippo API, you'll need to register for a free Shippo account and get your API Live token from the API page of the dashboard.

Sign up now to get your token

To create production shipping labels and make live requests, you must authenticate your requests using the Live Token. All code samples in these tutorials use your Test Token.


curl https://api.goshippo.com/shipments/  \
    -H "Authorization: ShippoToken <API_TOKEN>" \
    -H "Content-Type: application/json"  \
    -d '{...}'
require 'shippo'

Shippo::api_token = '<API_TOKEN>'
import shippo

shippo.api_key = "<API_TOKEN>"
require_once('lib/Shippo.php');
Shippo::setApiKey("<API_TOKEN>");
var shippo = require('shippo')('<API_TOKEN>');
package com.shippo;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

import com.shippo.exception.ShippoException;
import com.shippo.model.Rate;
import com.shippo.model.Shipment;
import com.shippo.model.Transaction;

public class Example {

	public static void main(String[] args) throws ShippoException {
		
		Shippo.setApiKey("<API_TOKEN>");

	    ...
	}
}
	
APIResource resource = new APIResource ('<API_TOKEN>');

Client Libraries

To make your integration process go faster, we've created client libraries in Ruby, PHP, Python, NodeJS, Java and C#. We recommend installing them first before you start with Shippo.

Learn more about client libraries here ▸

Test Mode

You can try out the Shippo API and get test labels for free by using your API Test Token instead of the Live Token.

Learn more about test mode ▸