API Accounts

OVERVIEW

The API Accounts page gives you a list of all the API accounts under your user account. You can have multiple API accounts per user.

You can view Key & Tokens, shipments and registered auths belonging to each user and disable or delete an API account. You can also create a new API account.

CREATING A NEW API ACCOUNT

1. First you need to click on the "Create New API Account" button on the top right corner of the page.

2. In the popup that you'll be presented with, give this new account a name and generate a key for this account. This key is unique to your account and although you will not have to input it in your requests directly, you can keep it somewhere if you'd like. 

3. Once this is all done, click "Save Changes" and your new API account will appear on the page.

CREATING TOKENS

Tokens are needed to create authentication requests via the API.  They are used to identify a request coming from a certain API user. So, to authenticate a request, you need a token tied to the relevant API user. To create tokens:

1. Click on "Keys & Tokens" next to the API account you wish to generate tokens for.

2. Then click on "Create Token".

3. After that, give your token a name and hit "Create Token" again.

4. Once saved, your new token will appear on the below screen. You can see the token value here or if you ever wish to remove this token, you can do so by clicking on the bin icon next to it.

ADD/VIEW REGISTERED AUTHS

To register a new auth:

1. Click on the plus icon next to the "View Registered Auths".

2. The next step is to select a courier from the drop-down list.

3. Then fill in the relevant fields. The "Company" field helps you differentiate your accounts if you've got multiple accounts with the same courier.

4. Make sure the Testing field is marked accordingly, ie, if you are in the testing mode make sure it is marked as "Yes" and if not, leave it as "No". 

5. Once all of this is done, click "Save Changes" and you will have successfully registered a new auth.

6. You can view your registered auths by clicking on "View Registered Auths".

From this pop-up, you can view presets defined for the courier for which you registered an auth, and see the details of this auth such as the username and password. You can also, of course, delete this registered auth anytime you need to by clicking on the red bin icon.