13min

Making an API Call

Overview

Here you will find out how to make API calls with your access token. The access token is always required for calling any of our APIs.

Below is an example of tracking a container using the POST method.

GraphQL
|

The following is the successful response body that you will get (go here to see the other responses).

JSON
|

Steps

The following is a step-by-step instruction on calling the Container Tracking API endpoint in Postman.

Making an API call
Making an API call

Note:

To import RPA Labs Postman Collection, please refer to the Postman Collection section.

Step 1: Select the Authenticate Endpoint

Navigate to Collection > Open Api > Authenticate.

Authenticate endpoint
Authenticate endpoint

Step 2: Set the Authenticate Body

Generate an access token with the Authenticate POST method. Set the body with your key and secret.

Document image

Step 3: Press the Send button

Press the Send button to call the authenticate API.

Document image

Below is the success response containing your access token.

Document image

Note:

Go here to know more detail about the Authenticate endpoint.

Step 4: Select the Container Tracking Endpoint

Navigate to Collection > Open Api > Container Tracking.

Container tracking endpoint
Container tracking endpoint

Step 5: Add Authorization Header

Go to the Headers tab and add an authorization key and set its value with your access token.

Document image

Step 5: Set the Body

Set which container you want to track in the request body.

Container tracking number
Container tracking number

Step 7: Retrieve the Response

Now you are ready to call the POST Container Tracking API. Hit the Send button.

Send button
Send button

✅Done! You will get the container information details as seen in the example below.

200 OK
|

🚩 If you get an unsuccessful response, please see the Error Handling section to figure out how to handle the errors.

✉️ Need some help?

If you encounter a problem or require assistance, please contact our support team with details regarding your request at support@rpalabs.com. A representative will connect with you soon. 😊





Updated 10 Jun 2022
Did this page help you?
Yes
No