API Quickstart

Get started with the APIs in 5 minutes

What you will need

You will need some tools to be able to call the API. A good place to start is using Postman or curl.


Accessing the API

Follow these steps to access ShipServ API:


Step1: Get a ShipServ account

To use the API, you would need to have a Trade Business or Enterprise Account. 


Step 2: Get an API Access Token

The API uses OAuth 2.0 for authentication and authorization. To get a token, you will need to use your Client ID and Secret.

To get your Client ID please contact us at support@shipserv.com


Step 3: Choose an API

Select an API to call. Place the token in the request authorization header every time you call the API.


Obtaining your access token

Using curl

curl --location --request POST 'https://test.shipserv.com/api/authentication/oauth2/token?client_id=XiFIZSSQo2EqVD75I8S1rpNUZURyJLnFx
&client_secret=hiFEh8JMV3mEfRgnJyKRsYhmODwZN43hz
&username=myuser@company.com&password=mypassword'

Output:

{   
    "access_token": "82N2JiYxo1YInWgOzmcKsAc25M9xieBR",  
    "token_type": "bearer",  
    "expires_in": 7200,  
    "refresh_token": "SEpNVvL3Hp2Adxmi1sGqbQTYUvGKgYiw",  
    "scope": "create"  
}  


Using Postman

Note: Access token expires in 2 hours. When you get an expired token response, you will have to get a new token by repeating the call above.