Quick start_
Choose an Appwrite partner integration model and take your first steps with OAuth connect or organization API keys.
2 min read
This quick start helps you pick the right integration path and wire up your first Console API call.
Choose your integration model
| Model | Best for | Auth |
|---|---|---|
| OAuth connect | Users link existing Appwrite accounts | User consent via OAuth 2.0 |
| Org API keys | Your platform provisions resources in your org | Organization API key |
Use OAuth connect when your customers already use Appwrite and want to grant your product access to their organizations.
Use org API keys when your platform creates and manages Appwrite projects, domains, and resources inside an organization you control.
Prerequisites
- An Appwrite Cloud account with an organization
- A server-side environment to store secrets (API keys or OAuth client credentials)
- The Appwrite Console SDK for Node.js, Python, or another server language
Step 1: Initialize the Console SDK
Partner integrations run on your backend. Initialize the Console SDK with your session or an organization API key:
Organization API keys and OAuth client secrets must stay on your server. Use your backend to call Console APIs and project APIs on behalf of users.
Step 2: List or create a project
With an org API key, list projects in your organization or create one for a new customer:
Step 3: Manage project resources
After you have a project, use the project SDK with a project API key or dynamic key to manage databases, storage, functions, and other services inside that project. See Manage resources.
Next steps
Was this page helpful?
Share what worked or what we should fix. Once approved, our agents automatically apply suggested updates to the docs.