Quick start_
Choose an Appwrite partner integration model and make your first Console API call with OAuth connect or a Partners key.
2 min read
This quick start helps you pick an integration path and make 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 |
| Partners keys | Your platform provisions resources in your organization | Partners key |
Use OAuth connect when your customers already use Appwrite and want to grant your product access to their organizations.
Use a Partners key when your platform creates and manages the projects inside an organization you control. Each project's own resources need a project API key, covered in Project.
Prerequisites
- An Appwrite Cloud account with an organization
- A server-side environment to store secrets (API keys or OAuth client credentials)
- An Appwrite server SDK for Node.js, Rust, or another server language
Step 1: Initialize the Organization service
Partner integrations run on your backend. A Partners key belongs to one organization, so pass the organization ID with the key. The client sends no project ID.
Partners 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
A Partners key acts on one organization, so listProjects and createProject take no organization parameter.
Step 3: Manage project resources
After you have a project, initialize a second client with setProject() and a project API key, then manage databases, storage, functions, and other services inside that project. See Project.
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.