Skip to main content

Access and usage

Set up access to the API and understand how your usage is calculated.

Setting up API keys

Generate API keys, secure them, and use them to authenticate requests from your services.

How credits work

Learn how credits are consumed, how usage is calculated, and how to avoid unexpected consumption in production.

Shipment structure

Learn how the components of a shipment fit together before configuring individual transport legs.

Cargo

Define the cargo being transported and provide the information needed for emissions calculations.

Locations

Describe shipment origins, destinations, and intermediate locations.

Transport chains

Combine shipment legs into a complete transport chain from origin to destination.

Hubs

Represent terminals, warehouses, ports, and other hubs within a transport chain.

Transport operations

Configure shipment legs for a specific transport mode or use a fallback when complete mode information is unavailable.

Road transport

Configure shipment legs transported by road.

Rail transport

Configure shipment legs transported by rail.

Water transport

Configure shipment legs transported by sea or inland waterways.

Air transport

Configure shipment legs transported by air.

Unknown transport

Model a shipment leg when the transport mode is unknown.

Weighted modes transport

Model a shipment leg using a weighted combination of multiple transport modes.