OpenRoadmap Docs

API overview

Hono Worker at your API origin. JSON in / JSON out. Public routes for the widget and portal; session-protected routes for the dashboard.

Base URL

EnvironmentBase
Localhttp://localhost:8787
Productionhttps://api.openroadmap.app

CORS

Controlled by Worker var ALLOWED_ORIGINS (comma-separated). Supports exact origins and *.openroadmap.app-style host suffixes. Credentialed requests allowed for dashboard session headers.

Auth

  • Public — no auth (widget + portal reads + votes)
  • Session — header X-OpenRoadmap-Session: <token> or Authorization: Bearer <token> from POST /v1/auth/login

Errors

shape · json
{ "error": "Domain not allowed for this project" }
StatusMeaning
400Validation (missing message / invalid status)
401Missing / invalid session
403Domain not allowlisted
404Unknown project, feature, or submission
Note

Health check: GET /health { ok, service, demo, kv, queue }