Authentication
Set up your organization's authentication method to start using Shipium's services.
First steps
To start using Shipium's APIs and services, you must first:
- set up your organization's account within the Shipium Console; and
- create an authentication method for your organization.
Create your Shipium account
Your Shipium Account provides 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 and is more frequently used than the OAuth 2.0 method.
- OAuth 2.0. This method uses the authorization request header or authorization uniform resource locator (URL) parameter and is used less often than the API key-based method.
You may also be interested in Shipium's single sign-on (SSO) service for authentication for your organization's account users.
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, as explained in the following table.
| Type of authentication | Calling method |
|---|---|
| API key-based Authentication using basic authentication | Your 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 Authentication using the authorization request header or authorization URL parameter | Your 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 Create API Credentials.
Resources
Your Shipium team member is available to help along the way. However, you might find these resources helpful:
Updated 5 months ago