Skip to main content

๐Ÿ“Š API Console

What is the API Console?โ€‹

The Dockflow API Console is where you set up and monitor your integration with Dockflow.

Access URL โ†’ https://console.dockflow.com

Sign in with your Dockflow account. Everything you see belongs to the organisation you are signed in to. To work on your UAT sandbox, switch to your UAT organisation.


API Keysโ€‹

The API Keys page has these tabs:

TabWhat you can do
API keysCreate, rename and revoke Trident API keys. See each key's environment, scopes and when it was last used. An Upstream key can be limited to tradeflows your company created. A new Widget key comes with a ready-made iframe snippet to copy. See Authorization and Widget Embed.
WebhooksAdd webhook destinations, set their headers, delay and delivery mode (Dry run / Live / Off). Open a destination to send a test record, see every call Dockflow made to it with the exact body that was sent, and resend any call. See Upstream โ€บ Webhook delivery.
v2 API messagesShown only if your organisation still receives the v2 upstream feed: the delivery history of that feed.

Other pagesโ€‹

PageWhat it shows
Import historyTradeflow imports and their outcome.
Data qualityTracking data quality metrics. See Data quality.
IntegrationsCredentials for the data sources Dockflow connects to on your behalf, e.g. terminals and port community systems. See Terminal integrations.
User ActivityHow your people use Dockflow: users active in the last 7 and 30 days, a daily active-users chart, and a per-company table with an Excel export.

Need help?โ€‹

Email [email protected]. Engineers typically respond within one business day.