انتقل إلى المحتوى الرئيسي

Developer Guide

This guide is for engineers building integrations against ORKSTRA — accounting sync, BI exports, custom clients, partner products, and anything else that wants to read or write data programmatically.

Topics​

  • API reference — pointer to the OpenAPI reference (Mintlify).
  • Webhooks — event subscriptions and signature verification.
  • Integrations — pre-built integrations and recipes.
  • SDKs — official client libraries.

At a glance​

  • REST API: OpenAPI 3.1, 854 endpoints. Base URL: https://api.orkstra.com/v1.
  • Auth: OAuth 2.0 — client credentials, authorization code with PKCE, refresh tokens.
  • Rate limit: 600 rpm default, 3000 rpm Premium.
  • Webhooks: HMAC-SHA256 signed, exponential retry up to 24h.
  • SDKs: TypeScript, Python, .NET (Q3 2026).

Quick start — pull a project list​

curl https://api.orkstra.com/v1/projects \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"

Returns:

{
  "data": [
    { "id": 1, "name": "Downtown Tower", "status": "in-progress" },
    { "id": 2, "name": "Marina Bay", "status": "awarded" }
  ],
  "pagination": { "total": 2, "page": 1, "per_page": 50 }
}

Authentication patterns​

Client credentials (server-to-server):

curl -X POST https://api.orkstra.com/oauth/token \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET" \
  -d "scope=projects.read ipcs.read"

Authorization code with PKCE (user apps):

See Webhooks for the full flow.

Versioning​

The API is versioned in the URL path. Breaking changes get a new major version (/v2). Old versions are supported for at least 24 months from the new version's release.

SLA​

  • API uptime: 99.9% (target).
  • Webhook delivery: at-least-once with 24h retry window.
  • Status: status.orkstra.com.

Getting help​