Integration Guide

Security Token: https://api.mycarrierpackets.com/token (Post call/grant_type: password)

Requires customer integration username and password. Admin can manage credentials by going to:

https://mycarrierpackets.com/IntegrationTools

Postman can be used for testing.

Response Format: By default, the response format from the apis will be JSON. To receive the api response in XML format, add an "Accept" header with the value "text/xml" to the request.

intellivite invite the carriers to complete packets either by:

1.1

RECOMMENDED: Create an invite screen in the TMS that allows users to enter a carrier DOT and the carrier’s email (preload intellivite approved carrier email addresses and other data with the preview API 1.1.2.1 below) to call our invite API (Post call/Token required):

1.1.1

With MCP User (Recommended) allows MCP to communicate with the user who sent the invitation:
https://api.mycarrierpackets.com/api/v1/Carrier/EmailPacketInvitation?dotNumber={DOTNumber}&docketNumber={MC,FF,MX}&carrierEmail={carrieremail}&username={customerusername} (Post call/Token required)

1.1.2

Or without MCP User:
https://api.mycarrierpackets.com/api/v1/Carrier/EmailPacketInvitation?dotNumber={DOTNumber}&docketNumber={MC,FF,MX}&carrierEmail={carrieremail} (Post call/Token required)

1.1.2.1

https://api.mycarrierpackets.com/api/v1/Carrier/PreviewCarrier?DOTNumber={DOTNumber}&docketNumber={MC,FF,MX} (Post call/Token required) can be used to preload approved emails, risk assessment, and preloaded certificate data, making the invitation more efficient.

1.2

Or add an intellivite link in a TMS generate email example:

1.2.1

(Recommended) https://mycarrierpackets.com/{CustomerIntelliviteID}/Carrier/Intellivite/{CustomerMCPUserID}/{DOTNumber}/{DocketNumber}

Example: https://mycarrierpackets.com/ea72823e-1506-4b72-a3b0-a488e1ba2f1e/Carrier/Intellivite/brenda/23868/MC113843 Adding the DOT number and Docket Number at the end of the url eliminates the need for carriers to add their DOT. User specific intellivite links allow for communication of who the carrier is working with at your company. This preferred method is the most efficient for overrides, communication, and ease of registration.

1.2.2

Or https://mycarrierpackets.com/{CustomerIntelliviteID}/Carrier/Intellivite/{CustomerMCPUserID} to send without the DOT and Docket. Note: Cannot send Docket Number without DOT, but you can send DOT only for intrastate carriers.

1.2.3

Or basic intellivite: https://mycarrierpackets.com/{CustomerIntelliviteID}/Carrier/Intellivite without the user, Docket, or DOT.

1.2.3.1

https://api.mycarrierpackets.com/api/v1/Carrier/PreviewCarrier?DOTNumber={DOTNumber}&DocketNumber={MC,FF,MX} (Post call/Token required) can be used to preload approved emails, risk assessment, and preloaded certificate data, making the invitation more efficient.

Note:

Customers can find the basic intellivite link in the integration tools page available to admins. Users can access their intellivite links under their profile in MyCarrierPackets.

1.3

Or use a URL to MCP to invite the carrier:

1.3.1

(Recommended)
https://mycarrierpackets.com/RegisteredCustomer/SendCarrierPacket?dotNumber={dotNumber}&docketNumber={docketNumber}

1.3.2

Or https://mycarrierpackets.com/RegisteredCustomer/SendCarrierPacket?dotNumber={dotNumber} for intrastate only carriers.

MyCarrierPackets

2.1

Check for completed carrier packets either by:

2.1.1

https://api.mycarrierpackets.com/api/v1/Carrier/completedpackets?fromDate={YYYY-MM-DDTHH:MM:SS}&toDate={YYYY-MM-DDTHH:MM:SS} (Post call/Token required)

2.1.2

Or provide MCP with an API to call. Provide a field for the DOT. Example: https://api.SampleCustomer.com/{DOTNumber}/{DocketNumber}

2.2

Update or add carrier packets for DOT numbers found on the above api using https://api.mycarrierpackets.com/api/v1/Carrier/GetCarrierData?DOTNumber={DOTNumber}&Docket={MC,FF,MXNumber} (Post call/Token required)

2.3

Add a “View Carrier” Button for each carrier profile in the TMS with either URL (to view MyCarrierPacket and/or Assure Advantage data):

2.3.1

2.3.2

Or https://mycarrierpackets.com/CarrierInformation/DOTNumber/{dotNumber} for intrastate only carriers.

Assure Advantage Carrier Monitoring:

3.1

Initial and Periodic Full Carrier Sync

3.1.1

Get Monitored List from MCP:

3.1.1.1

(Recommended) Using our Monitored Carriers API https://api.mycarrierpackets.com/api/v1/Carrier/MonitoredCarriers?pageNumber={1}pageSize={default is 2500, max is 5000} (Post call/Token required)

Note: The pagination data is returned in the response header.
Header Name: X-Pagination
Header Value: {"pageNumber":1,"pageSize":2500,"totalPages":10,"totalCount":25000}

3.1.1.2

Manually have customer export the list at https://mycarrierpackets.com/CarrierMonitoring

3.1.2

Compare MCP/TMS carrier lists:

3.1.2.1

For carriers not monitored in MCP that TMS has to be monitored, use: https://api.mycarrierpackets.com/api/v1/Carrier/RequestMonitoring (Post call/Token required) to add to carriers MCP monitored list.

3.1.2.2

For carriers monitored in MCP that TMS has not to be monitored, use: https://api.mycarrierpackets.com/api/v1/Carrier/CancelMonitoring (Post call/Token required) to remove carriers from MCP monitored list.

3.1.3

Update Carrier list:

3.1.3.1

For batch update on all carriers, call https://api.mycarrierpackets.com/api/v1/Carrier/MonitoredCarrierData?pageNumber={1}pageSize={default is 250, max is 500} (Post call/Token required)

Note: The pagination data is returned in the body of the response.

3.1.3.2

Or for each Carrier, call https://api.mycarrierpackets.com/api/v1/Carrier/GetCarrierData?DOTNumber={DOTNumber}&Docket={MC,FF,MXNumber} (Post call/Token required)

3.2

Carrier Batch Updates (call apis at no less than 4 minute intervals)
https://api.mycarrierpackets.com/api/v1/Carrier/CarriersChanges?fromDate={YYYY-MM-DDTHH:MM:SS}&toDate={YYYY-MM-DDTHH:MM:SS}&pageNumber={1}pageSize={default is 250, max is 500} (Post call/Token required)

Note: The pagination data is returned in the response header.
Header Name: X-Pagination
Header Value: {"pageNumber":1,"pageSize":250,"totalPages":10,"totalCount":2500}

3.3

Request Certificates of Insurance

3.3.1

3.3.2

Or https://mycarrierpackets.com/CarrierInformation/DOTNumber/{dotNumber}?requestInsurance=true for intrastate only carriers.

3.4

Update carrier now button: Pulls carrier data in real-time (section 2.2 above).

3.5

Pull image of Certificate of insurance (see 4.1 below).

3.6

Monitor Carrier

3.6.1

Add to Monitored List: https://api.mycarrierpackets.com/api/v1/Carrier/RequestMonitoring (Post call/Token required)

3.6.1.1

Body: DOTNumber, DocketNumber, and/or IntrastateNumber

3.6.2

Remove from Monitored List: https://api.mycarrierpackets.com/api/v1/Carrier/CancelMonitoring (Post call/Token required)

3.6.2.1

Body: DOTNumber, DocketNumber, and/or IntrastateNumber

Pull Carrier Packet and Assure Advantage Images:

4.1

Pull each document individually: https://api.mycarrierpackets.com/api/v1/Carrier/GetDocument?name={Blobname} (Post call/Token required) for Certificate of Insurance, W9 and eAgreement GetCarrierData API in section 2.2 above.

4.1.1

If testing in Postman, click Save Response to download.

4.2

Or pull full packet via a URL (packet only) images, use https://mycarrierpackets.com/Download/GetCarrierPacket?DOTNumber={DOTNumber}&inline=True

4.2.1

Requires a user to be logged in.

4.3

Or pull the full packet as one PDF via an API using a token API and Packet API https://mycarrierpackets.com/api/Download/CarrierPacket/{DotNumber} (Get call/Token required)

4.3.1

Use separate token API https://mycarrierpackets.com/api/token (Get call/grant_type: password)

4.3.2

If testing in Postman, click Save Response to download.

Integration Notes:

When mapping data fields, if a carrier is set to monitor, and no data is sent from The Descartes Systems Group, Inc., the fields should be blank.

When mapping data fields, the fields should be locked not allowing users to type information in unless the carrier is unchecked for monitoring. This way, the system always whose data is being viewed.

Initial sync and periodic update process:

The user should be able to run a report of all carriers monitored within the TMS.

Customers can upload their list of monitored carriers in the Upload page of MyCarrierPackets.

The TMS should clear all mapped monitoring fields in the TMS, and pull an update on all carriers using the GetCarrierData API in section 2.2 above.