Developer Reference

Dock Optimizer Developer Docs

Two surfaces, one set of credentials. Use REST for partner TMS/ERP integrations and Integration Hub connectors. Use MCP to wire AI agents (Zo, Claude Desktop, LangChain, Cursor) into facility operations.

๐Ÿค” Which should I use?

Use caseRecommended surfaceWhy
Partner TMS/ERP polling for appointments or facility state REST Predictable HTTP semantics, codegen-friendly OpenAPI spec, ETag/Link/If-None-Match for cheap polling
Integration Hub connector reading from Dock Optimizer REST Same auth as MCP, simpler client code, no JSON-RPC envelope
AI agent that reads state and creates appointments MCP Tool calling (tools/call) + resource reads (resources/read) in one protocol; idempotency keys for safe retries
AI agent that proposes risky actions (door blocks, flags, reports) MCP Built-in HITL queueing โ€” actions wait for admin approval before executing
Inventory receipts / issues / cycle counts from a WMS agent MCP Audited transactions with agent attribution, real-time SignalR broadcast to org users
Reporting dashboard polling for org-wide metrics REST + MCP REST for stable JSON shapes; MCP resources/read for richer data-quality and operations summaries

๐Ÿค What's shared

Both surfaces share one credential, one rate-limit bucket, one audit trail. A single API key works against both โ€” you don't generate separate keys for REST and MCP.

ConcernWhere
Authentication & key typesDetailed on each surface page; same Bearer token model
Rate limits (60/min, 1000/day, optional per-hour write ceiling)Shared bucket per key; documented on each surface page
Audit logging (AgentAuditLogs)Every authenticated call from either surface; REST entries prefixed REST_GET
Key management (/api/agent-keys/*)Admin-cookie endpoints for generate/rotate/revoke
DiscoveryMCP manifest ยท OpenAPI spec ยท Swagger UI

๐Ÿš€ Getting Started

  1. Generate an API key in Integration Hub โ†’ Agent Keys. Use scopes: "read" first, set contactEmail, set expiresAt 90 days out, copy the do_live_โ€ฆ token (shown once).
  2. Pick your surface:
    • Partner integration / TMS-ERP polling โ†’ REST docs
    • AI agent / tool calling โ†’ MCP docs
  3. Discover endpoints: REST clients pull the OpenAPI spec; MCP clients pull the manifest and call tools/list + resources/list.
  4. Promote to write only after read-paths are stable. Rotate the key with scopes: "read,write" and the minimum capabilities array your agent needs.