Skip to content
Last updated

Pre-Gate API

The Pre-Gate API enables developers to digitize and automate pre-arrival workflows for cargo facilities.

The Pre-Gate API enables developers to digitize and automate pre-arrival workflows for cargo facilities.


It helps terminals, ports, and logistics platforms validate cargo, appointments, and compliance requirements before a truck arrives at the gate, reducing congestion, delays, and manual intervention.


By shifting checks upstream, Pre-Gate improves gate throughput, operational efficiency, and the overall driver experience.


Explore Ocean Terminals

Connects marine terminal operators and shipping lines with their external users, including motor carriers, beneficial cargo owners, and freight forwarders, to simplify appointments, payments, and cargo visibility. Reduce congestion, streamline fee collection, and improve coordination.

What is Pre-Gate?

Pre-Gate acts as a pre-validation layer between external users (motor carriers, freight forwarders, beneficial cargo owners) and cargo facilities. It ensures that all required conditions—such as appointments, payments, and documentation-are verified in advance, allowing trucks to move through terminals faster and with fewer exceptions.

The API is designed to integrate seamlessly with terminal systems, appointment platforms, and payment services, including other CargoSprint products.

Key Capabilities

  • Pre-arrival validation: Verify that a truck, container, and driver meet terminal requirements before arrival.

  • Appointment verification: Confirm pickup or drop-off appointments and slot availability in advance.

  • Payment and fee checks: Ensure required fees are paid or authorized prior to gate entry.

  • Exception detection: Identify missing documents, invalid appointments, or unpaid charges early.

  • Real-time status responses: Provide immediate feedback to drivers or dispatch systems.

Authorization

All API requests must include the following HTTP headers for authentication and user impersonation.

Required Headers

HeaderDescription
X-Cargosprint-Api-KeyThe company API key provided by Cargosprint.
X-Cargosprint-User-KeyThe API key of the user to be impersonated.

Get X-Cargosprint-Api-Key

To obtain a company API key, please reach out to Cargosprint customer support.

The provided API key must be included in the X-Cargosprint-Api-Key header for all API requests.

Get X-Cargosprint-User-Key

Within the Cargosprint eModal Profile page, eModal users can generate personal API keys intended to be shared with partner companies.

These user-generated keys must be passed in the X-Cargosprint-User-Key header.

Request Requirements

Both headers are mandatory and must be included in every API request to ensure:

  • Proper authentication of the partner company.
  • Correct user impersonation and security context.

Example Request

GET /api/example HTTP/1.1
Host: api.cargosprint.com
X-Cargosprint-Api-Key: your-company-api-key
X-Cargosprint-User-Key: user-generated-api-key

Notes

  • Requests missing either header may be rejected with an authorization error.
  • API keys should be treated as sensitive credentials and stored securely.
  • Any other methods of user impersonation will be forbidden.
  • In case of a partner company breach, hacking, or intrusion, immediately contact eModal.

How Pre-gate Fits Into the CargoSprint Platform

Pre-Gate works seamlessly with other CargoSprint solutions:

Together, these APIs enable a fully connected, end-to-end cargo workflow-from planning to gate entry.