Making an API Call

12 min

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.

The following is the successful response body that you will get.

{
    "data": [
        {
            "tracking_events": [
                {
                    "weight": 247.0,
                    "pieces": 16,
                    "flight_number": "",
                    "time": "2022/6/23 23:22:00",
                    "code": null,
                    "location": "HKG",
                    "is_estimated": false,
                    "description": "Freight on hand",
                    "serial_number": "1"
                }
             ],
            "awb_number": "16044945493",
            "id": "62eb2bd840dde2d263c11d21",
            "updated_at": "2022/7/17 8:19:01",
            "tracking_finished_time": "2022/7/15 8:13:43",
            "carrier": {
                "airline": "CATHAY PACIFIC AIRWAYS",
                "code": "CX"
            },
            "airport": {
                "origin": "HKG",
                "origin_code": null,
                "destination_code": null,
                "destination": "KIX"
            }
        }
    ]
}

Steps

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

Making an API call

Note:

To import Rippey AI Postman Collection, please refer to the Postman Collection section.

Step 1: Select the Authenticate Endpoint

Navigate to Collection > Track and Trace > auth >login.

Step 2: Set the Authenticate Body

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

Step 3: Press the Send button

Press the Send button to call the authenticate API.

Below is the success response containing your access token.

Note:

Go here to know more detail about the Authenticate endpoint.

Step 4: Add Authorization Header

Navigate to Collection > Track and Trace > Air | Ocean > subscribe air waybill | container

Do not forget to add the Authorization header [See step 4]

Step 6: Select the Tracking Endpoint

Navigate to Collection > Track and Trace > Air | Ocean > get air waybills | containers

Do not forget to add the Authorization header [See step 4]

Step 7: Set the Params

Set which container you want to track in the query parameters.

Step 8: Retrieve the Response

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

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

{
    "data": [
        {
            "tracking_events": [
                {
                    "weight": 247.0,
                    "pieces": 16,
                    "flight_number": "",
                    "time": "2022/6/23 23:22:00",
                    "code": null,
                    "location": "HKG",
                    "is_estimated": false,
                    "description": "Freight on hand",
                    "serial_number": "1"
                }
             ],
            "awb_number": "16044945493",
            "id": "62eb2bd840dde2d263c11d21",
            "updated_at": "2022/7/17 8:19:01",
            "tracking_finished_time": "2022/7/15 8:13:43",
            "carrier": {
                "airline": "CATHAY PACIFIC AIRWAYS",
                "code": "CX"
            },
            "airport": {
                "origin": "HKG",
                "origin_code": null,
                "destination_code": null,
                "destination": "KIX"
            }
        }
    ]
}

🚩 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 [email protected]. A representative will connect with you soon. 😊