🚀 Getting Started
Early‑Access API
🚧 Heads‑up! This is our next‑generation API and it’s still under active development.
How you can help
- Try it out in non‑production environments first.
- Report issues or request features by mailing [email protected]
Thank you for partnering with us to shape the future of our platform!
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 🔑
- Open Settings ▸ API Tokens in the Dockflow app.
- Select scope →
downstream,upstreamorwidget.
A token only authenticates the endpoints that belong to its scope. - Pick Production or UAT sandbox and copy the token.
# every request is authenticated like this 👇
-H "Authorization: prod_downstream_f36d0c4e..." # or uat_widget_...
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 | Scope |
|---|---|---|
| Downstream | /v3/downstream | downstream |
| Upstream | /v3/upstream | upstream |
| Widget API | /api/v2/widget-search | widget |
| Widget iframe | N/A (browser embed) | widget |
| Weblink | /redirect (browser link) | none |
All endpoints use the same host: https://api.dockflow.com (or https://uat.dockflow.com for sandbox).
4 · Documentation map
| Topic | Go to |
|---|---|
| Send tradeflows & documents (Downstream) | Downstream guide |
| Receive milestones & alerts (Upstream) | Upstream guide |
| 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.