Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Tip

Goal

Each of the data attributes sent to Freight Tiger platform using Trip APIs should be visible across all pages:

  1. My Trips UI

  2. Trip Reports

  3. Analytics Dashboard

Overview

Following are the steps to demonstrate the calls that are made for an end to end trip integration:

  1. Create a new trip

  2. Update the same trip with reference of Trip - lrid (FT Trip ID which was returned in Add Trip API response or feedUniqueId which is a unique identifier added in Add Trip API payload)

  3. Push User-defined Trip Milestone Events into the trip.

  4. Validate the data created in above steps on FT screens.

  5. Validate the data created in above steps on Analytics dashboards.

Prerequisites

To execute this script, you need following:

  1. JSON Web Token: read more. If you don't have it already, kindly raise a ticket here.

  2. Username & Password Credentials to your account on <URL> for checking the data on FT UI.

  3. Ensure our IPs are whitelisted for both environments:
    Sandbox - 13.126.98.143
    Production - 13.234.139.9

Two-Tier Environments

Integration/Sandbox Environment (IP: 13.126.98.143)
URL: https://integration.freighttiger.com

...

View file
nameFT Trip APIs - Production env.json
View file
nameFT Trip APIs - Integration env.json

Add Trip

Info

You may identify any uniqueID from your system to be added as “feedUniqueId”. This field can be used as a parameter for other API consumption and will also prevent any duplication of trips created.

...

Check Data In Trip Analytics Report

  1. Goto https://www.freighttiger.com, login

  2. Go to report → Trip analysis

  3. Select All Trips

  4. Select period which consists of the date of trip that you created in this demo

  5. Image Modified

    Select all trips

  6. Enter your mail ID

  7. Click on EMAIL

  8. Image Modified

    Check your mail and download the sheet.

  9. All the data you have sent should be in the sheet you received on mail.

Check Data In Trip Analytics Dashboard

  1. Go to https://www.freighttiger.com, login

  2. Go to Dashboards → Trip analytics

  3. Image Modified

    Enter a date range that includes the trip created in this demo script

  4. Image Modified

    Click on Number of Trips. This will open a pop-up.

  5. Export as Excel or CSV

  6. Image Modified
  7. All the data Analytics data should be in the sheet.