Overview

Guides are organised by "what do I want to do", complementing the API Reference which is organised by resource. Every guide opens with a clear developer goal (e.g. "let my SaaS users sign in with their AppForges account") and walks step-by-step to runnable code.

Topics

• Authentication — choose between User / Org identity and OAuth / API Key credentials and implement them
• Webhooks — register subscriptions, verify raw-body signatures and understand protocol boundaries
• Errors and retries — unified error model, when to retry, X-Idempotency-Key usage
• Versioning and upgrades — /v1/ + X-AppForges-Api-Version request header and resolved version

Recommended reading path

First-time integration:

1. Quickstart — 5-minute first API call
2. Choose your auth — pick an identity type
3. Errors and retries — write a robust client
4. Versioning and upgrades — upgrade without surprises

• Small-file uploads — encode binary JSON payloads using the official SDK