DeltaTrak API Documentation

FlashTrak API

Number of APIs: 29

Introduction

The purpose of this document is to set the design requirements of the Application Programming Interface (API) for supporting the data integration services of the FlashTrak-RTL Web Application. The FlashTrak-RTL Wed Application is used for managing transportation conditions with the Real Time Data Loggers (RTL) of DeltaTrak.

General Requirements

The following general requirements shall apply to the FlashTrak Data Service:

Service URL
The FlashTrak-RTL data service shall be available at data.flashtrakrtl.com via a secure connection.
Pinging and Versioning
The service shall respond when entering its URL in a web browser. The response shall be in the format of text such as “FlashTrak-RTL API x.x”, where x.x shall represent the current version of the API software. Any additional interaction with the service shall require Client’s Authentication.
Authentication
The FlashTrak-RTL Service shall require Token string for authenticating Client’s requests. The Client must have an existing User profile in the FlashTrak-RTL Application and must be a member of the Account Administrators group i.e. a User with all access rights. The Client authentication shall be required for every transaction using the API.
Obtaining the Token
A token for accessing the FlashTrak-RTL Service can be generated upon request by contacting DeltaTrak customer support.
Transaction Format
Transactions with the services shall use JSON data objects. Every API function shall have its own JSON service end point.

1. Customer Endpoints-Shipments - Complete Shipment

PUT {{baseUrl}}/shipment/:tripNumber/complete

2. Customer Endpoints-Shipments - Delete

DELETE {{baseUrl}}/shipment/:tripNumber

3. Customer Endpoints-Shipments - List

GET {{baseUrl}}/shipment?tripNumber=Shipment Trip Number&shipperID=Shipper ID&receiverID=Receiver ID&status="Completed" | "Pending" | "Registered" | "Activated"&createdAt=2022-03-01 11:00&query=count&page=1&qty=10