REST API v1 and OAuth
Authenticate with API keys and scopes, follow the API conventions, create leads and draft invoices, and understand the OAuth 2.1 + PKCE app sign-in.
Mga aralin
Nakasulat sa English ang mga developer na aralin: English ang code, ang mga pangalan ng API at ang mga pangalan ng file saanman.
- API keys and scopesHow keys are created and sent, which scopes exist, and what the API answers when a key is missing, wrong or too weak.mga 7 min
- API conventions: money, lists, errors and limitsMinor-unit money, pagination and filters, the error shape, rate limits, Idempotency-Key and the headers on every answer.mga 8 min
- The resources of API v1Which endpoints exist, what they do and which scope each needs — including the hosted-only and app-only ones.mga 6 min
- Create a lead and a draft invoiceTwo real write calls with curl and with TypeScript fetch, including an Idempotency-Key for safe retries.mga 10 min
- OAuth 2.1 + PKCE app sign-inHow the zmle mobile and desktop apps sign in: discovery, authorization code with S256 PKCE, rotating refresh tokens and revocation.mga 10 min
- The reference page and the OpenAPI documentUse /api/v1/docs to browse and /api/v1/openapi.json to generate a typed client, and read the API request log when something fails.mga 5 min