🚀 Getting started (Trident API)
Using Dockflow in the browser?
This section is for API integration. For how to use the web app (dashboard, automations, terminals), start with the product introduction.
Dockflow offers a single REST API.
Use it to push purchase orders and containers into the platform and to pull milestones, documents and analytics back into any system.
1 · Create an API token 🔑
- Sign in to the API Console at console.dockflow.com and open API Keys.
- Create a key, pick Production or UAT and the scopes it is for:
downstream,upstreamorwidget. - Copy the key. It is shown only once.
# every request is authenticated like this 👇
-H "Authorization: prod_acme-logistics_Zk3n1c0Q2m9..." # or uat_acme-logistics_...
Key format, environments and error codes: Authorization.
2 · Typical integration flow
- Use Downstream API to create or update tradeflows and upload documents in Dockflow.
- Upstream delivers real‑time status, ETA changes and analytics from Dockflow.
- Widget & weblink endpoints add lightweight UI options.
3 · Pick the right endpoint
| Direction | Path | Authentication |
|---|---|---|
| Downstream | /v3/downstream/tradeflows | API key (downstream) |
| Documents | /v3/downstream/documents | API key (downstream) |
| Upstream (polling) | GET /v3/upstream | API key (upstream) |
| Upstream (webhook) | Dockflow POSTs to your HTTPS endpoint | Headers you configure |
| Widget API | GET /v3/widget/search | API key (widget), see Widget API |
| Widget iframe | embed.dockflow.com/track (browser embed) | API key (widget), see Widget Embed |
| Weblink | /redirect (browser link) | none |
The /v3 endpoints share one host: https://api.dockflow.com (or https://uat.dockflow.com for the sandbox). A widget-scope token is limited to the widget endpoints and cannot be combined with other scopes; the older /api/v2/widget-search endpoint takes a widget key instead.
4 · Documentation map
| Topic | Go to |
|---|---|
| Send tradeflows & documents (Downstream) | Downstream guide |
| Receive milestones & alerts (Upstream) | Upstream guide |
| API keys, key format & auth errors | Authorization |
| UAT sandbox & mock tracking | UAT environment |
| On‑the‑spot JSON search (Widget API) | Widget API |
| Embed a Dockflow view (Widget iframe) | Widget iframe |
| Deep‑link users into Dockflow | Weblink |
Need help? Email [email protected] – engineers reply within one business day.