Skip to main content
Shipturtle open APIs

A guide to using Shipturtle APIs

Y
Written by Yash J
Updated over 5 months ago

In this guide, we will walk you through the steps to using the Shipturtle API.
You can access our API Documentation here –

Access tokens are essential for interacting with Shipturtle’s API, as they authenticate and authorize users, ensuring secure access to our services. This section guides you through the process of obtaining an access token, enabling you to start leveraging the API’s capabilities.

Pre Requisites for Using APIs

To Access the feature of API INTEGRATION, you will need to take the API Integration add-on. Navigate to Settings> Subscription and billing.

Creating an Access Token

1. Navigate to the API Integration Section:

On the Shipturtle Dashboard, go to "API integration."

2. Create a New Access Token:

Click on "Create Access Token."

3. Configure Access Token Settings:

  • Set the "username" and "password."

  • Choose the API Access Permissions you need: "Order API Access," "Product API Access," or both.

4. Generate the Access Token:

  • Click on "Create Access Token."

  • Copy the generated access token.

5. Share the Access Token:

Provide the copied access token to your developer.

Revoking an Access Token

1. Initiate the Revocation Process:

  • In the API integration section, find the token you wish to revoke.

  • Click on the "delete button" under the "action" column.

2. Confirm the Revocation:

Click on the "revoke" button to disable the token.

Note: Once an API Access Token is revoked, it will be immediately disabled. Any API requests using this token will be rejected, which may cause systems depending on it to fail. After revocation, the API Token will no longer be viewable.

Did this answer your question?