Set up your organization's authentication method to start using Shipium's APIs.

First steps

To start using Shipium's application programming interfaces (APIs), you must first:

  • set up your organization's account within the Shipium Console; and
  • create an authentication method for your organization.


Creating your Shipium account

See Getting Started with Shipium for more information about setting up your organization's Shipium account.

There are two ways to request authentication to use our APIs:

  • API key-based authentication. This method uses basic authentication. Most people use this method.
  • OAuth 2.0. This method uses the authorization request header or authorization uniform resource locator (URL) parameter.

The primary difference between authentication methods

The data flow between the API key-based authentication and OAuth 2.0 methods differs in how you use them to make subsequent calls to the API. This is explained in the following table:

Type of authenticationCalling method
API key-based authentication using basic authenticationYour organization authorizes the request as part of each API call it makes, by passing your API key information in the Authorization field.
OAuth 2.0 using the authorization request header or authorization URL parameterYour organization authorizes and then receives a token and an expiry time.
You use that token for your calls to the other APIs.


For more information

Visit the following resources for more information about authentication:

Next steps

If you're ready to do some testing, start by reading Creating API Credentials.

Terminology guide

See Common Terms and Definitions.