🧪 UAT / test environment

Early‑Access API

🚧 Heads‑up! This is our next‑generation API and it’s still under active development.

How you can help

1. Try it out in non‑production environments first.
2. Report issues or request features by mailing [email protected]

Thank you for partnering with us to shape the future of our platform!

Base URL

https://uat.dockflow.com/v3

UAT mirrors the production API surface.
The only difference is authentication and the optional mock‑tracking features described below.

Environment	Host	Required token prefix
Production	api.dockflow.com	prod_…
UAT (sandbox)	uat.dockflow.com	uat_…

Production keys are rejected on UAT, and vice versa.

---

Mock tracking

When posting a tradeflow to /downstream/tradeflows in UAT, include the field mock_tracking.
Dockflow will automatically generate events that simulate real‑world progress.

Basic format

{
  "tradeflow_reference": "PO4564268",
  "container_reference": "ABCD1234567",

  "mock_tracking": {
    "scenario": "ocean_full",   // one of the predefined codes
    "speed": "fast"             // optional: fast ‖ normal ‖ slow
  }
}

Property	Type	Default	Description
scenario	string	–	Selects the event template (table below).
speed	string	normal	fast ≈ minutes, normal ≈ hours, slow ≈ days between events.

Predefined scenarios

Code	Events that will be generated
ocean_basic	Vessel departure → Final arrival
ocean_full	Gate‑in → Load vessel → Departure → Transshipment → Discharge → Gate‑out → Delivered
rolled_shipment	Same as ocean_full, but with an additional rolled milestone and adjusted ETA.
delayed_eta	Vessel departure → ETA postponed twice before arrival.
empty	No automatic events (useful to verify idempotency only).

Custom events

For full control, send your own events array (see Tradeflows API). If both events and mock_tracking.scenario are present, the custom events are appended after the mock sequence.

---

Usage example

curl -X POST https://uat.dockflow.com/v3/downstream/tradeflows \
     -H "Authorization: uat_e7d51f4d5719462d958e4b31" \
     -H "Content-Type: application/json" \
     -d '{
           "tradeflow_reference": "PO4564268",
           "container_reference": "ABCD1234567",
           "mock_tracking": { "scenario": "ocean_full", "speed": "fast" }
         }'

Response:

{
  "status": "queued",
  "tradeflows": [
    { "tradeflow_reference": "PO4564268", "created": true }
  ]
}

Events start appearing within seconds when speed is fast.

---

Data retention & limits

• Retention: data is wiped every Monday 00:00 UTC.
• Rate limits: identical to production (bursts of 120 req/min, 5 MB payload).
• E‑mails & webhooks: disabled; mock events are visible via the API only.

---

Use UAT to validate integrations safely before switching to production. For questions about tokens or mock scenarios, contact Dockflow support.