⚽ Start
Dockflow API
Alle features and data of the Dockflow platform are available via API. Use this guide to get started.
Getting started
The first step to integration is obtaining authorization via an API token.
After that, the API roughly falls apart in two categories. Terminology is based from a Dockflow point-of-view:
- If data is incoming to Dockflow from your system, this is a 🔽 downstream integration
- If data is outgoing from Dockflow to your system, this is a 🔼 upstream integration
- If data is outgoing from Dockflow to a web-widget, this is a 💻 web-widget integration
Typically, projects would start with a downstream integration - sending data to Dockflow, and after that implement the upstream integration - receiving data back to the original system.
Difference between upstream and web-widget: When you would like to have your system/database continually patched with all the latest updates about your shipments, choose the upstream API integration. If you need a full view of a shipment based on a user query (such as a container or booking ref, use the web-widget API.