← Tilbage til docs

REST API v1 reference

/api/v1/* er qlim8's public REST API. Auth via Bearer-tokens (apiKeys-tabellen). Cursor-pagineret, RFC 7807-fejlformat, OpenAPI 3.1-spec eksponeret. Routerne ligger i server/v1/ opdelt i 14 sub-moduler. Tier-gates pr. endpoint via subscriptionFeatures.ts.

Auth
Authorization: Bearer <key>
Keys er præfixet (fx tk_live_…).
Errors
application/problem+json (RFC 7807)
Rate-limit
Delt bucket med MCP, 100 req/min pr. key
Pagination
limit (default 20, max 100), cursor (base64-keyset)

Identity & keys

GET/v1/me
POST/v1/api-keys
GET/v1/api-keys
DELETE/v1/api-keys/{id}

Emissions & activities

GET/v1/emissions
GET/v1/emissions/{id}
GET/v1/activities
GET/v1/activities/{id}

Factors & lineage

GET/v1/factors
GET/v1/factors/{id}
GET/v1/lineage/{emissionEntryId}

Audit

GET/v1/audit

Suppliers (Enterprise)

Kræver Enterprise-tier med supplyChain-feature.

GET/v1/suppliers
POST/v1/suppliers/{id}/invite
GET/v1/suppliers/{id}/allocation

Reduktionsmål

GET/v1/targets
POST/v1/targets
GET/v1/targets/{id}/progress

Tenant

GET/v1/tenant
PUT/v1/tenant

Reports (async)

POST/v1/reports
GET/v1/reports
GET/v1/reports/{id}
GET/v1/reports/{jobId}/status

Webhooks

POST/v1/webhooks
GET/v1/webhooks
DELETE/v1/webhooks/{id}
POST/v1/webhooks/{id}/test
POST/v1/webhooks/{id}/replay
GET/v1/webhooks/{id}/deliveries

Admin (super-admin)

GET/v1/admin/metrics

OpenAPI

GET/v1/openapi.json

Kendte begrænsninger

  • — Ingen versionering ud over /v1 — breaking changes kræver /v2.
  • — Cursor-pagineret kun — ingen offset-pagination.
  • — Bulk-operations mangler (fx batch-opret aktiviteter).
  • — Rate-limit pr. tenant, ikke pr. nøgle — én nøgle kan udmatte hele tenant-bucketet.

Roadmap

  • — /v1/activities batch-POST.
  • — GraphQL-alternative for kompleks aggregation (under afvejning).
  • — Per-key rate-limit.
  • — Webhook-replay-bulk via filtre.

Foretrækker du JSON-RPC og agent-tools?

Hvert REST-endpoint har et tilsvarende MCP-tool. Samme auth, samme rate-limits, optimeret til AI-agenter.