Skip to main content

Authentication

Access to the Panjiva API is controlled through the use of authentication tokens. All requests to the Panjiva API, with the exception of the request to generate a new token, require a valid token to be present.

Locate your Authentication Settings

Log into your account at Panjiva.com, click the myPanjiva button in the top-right corner, and then select the 🔧 API Settings Option.

tip

If you do not see API Settings listed as an option, please contact your Panjiva representative to request access to the API.

Once you have successfully navigated to the API Settings Page, you will be able to view the client id and client secret for your API application, along with any generated OAuth tokens.

Generating OAuth tokens

New OAuth tokens may be generated through the API Settings page within the Panjiva.com application by clicking the Get New Token link.

Alternatively, OAuth tokens may also be programmatically generated through the API by making a request with the client_id and client_secret as described here.

info

All OAuth tokens generated are valid for a period of 24 hours, at which period a new token must be generated for new API requests.

Authenticating Your Requests

In order to authenticate API requests, the OAuth token value must be placed in the Authorization HTTP header field with a value formatted as Bearer TOKEN, as stated in the Bearer Token Usage specs.

Rate Limits

Each OAuth Token can only be used against the API to make 20 requests / second. Further requests will be denied with an HTTP Status code of 429

Revoking OAuth Tokens

If you no longer wish to use an OAuth token prior to its expiration, you may revoke the token using this endpoint.

Retrieve Token Expiration

You may retrieve the details of the OAuth token, including its time of expiration, by using this endpoint.