Authentication
Making an API Call
12min
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 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 step 5 subscribe to the cargo 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 200 ok { "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 support\@rippey ai a representative will connect with you soon π