Resources

API reference.

REST and webhooks over the same vessel record the solvers use. No separate reporting API.

Surface

The endpoints that matter.

ResourceMethodsNotes
/vessel-callsGET, POST, PATCHThe vessel record, including per-field provenance
/berth-planGET, POSTCurrent allocation, with the binding constraint per vessel
/yard-planGET, POSTSlotting plan and move list
/documentsGET, POSTCustoms filings and generated documentation, versioned
/eventsGET, webhookEvery state change, replayable from any point in the last 90 days
/statusGETTenant health and adapter acknowledgement state

Authentication is mutual TLS with a client certificate per integration. Rate limits are per tenant and published in the response headers.

Sandbox

A tenant you can break.

Access
Sandbox tenant issued during Week 1 of implementation, or on request before contract
Data
Synthetic vessel traffic replayed from an anonymised month
Reset
Self-service reset to a clean state at any time
Webhooks
Delivered to your endpoint with signed payloads and replay on failure

Next step

Ask for sandbox access.

We issue it before contract if your team wants to try the API first.