Proxy_
Proxy Appwrite Console and project APIs from your partner platform using organization and project credentials.
2 min read
Many partner platforms expose a simplified API or UI while Appwrite remains the backend. Your server proxies requests to Appwrite using organization API keys and per-customer project credentials.
Architecture
Customer app → Your platform API → Appwrite SDK → Appwrite CloudYour platform API:
- Authenticates the customer with your auth system
- Resolves the customer to an Appwrite
projectIdand credentials - Forwards or composes Appwrite operations
- Returns responses shaped for your product
Two-layer proxy
- Console layer: Org API key + Console SDK for organizations, projects, and domains
- Project layer: Project API key + project SDK for databases, storage, functions, and auth
Map each customer in your database to an Appwrite projectId (and optionally teamId).
Example: create customer workspace
Example: proxy resource operation
After provisioning, use a project-scoped key to perform resource operations:
Credential storage
Store per-customer project API keys or use short-lived tokens your backend mints after authorization. Never send org or project API keys to browsers.
Rate limits and errors
Your proxy should:
- Forward Appwrite error codes to your API consumers with safe messages
- Implement retries for transient failures
- Respect rate limits using API keys on server calls
- Log requests with your customer ID and Appwrite project ID for support
Translate Appwrite response codes into your platform's error format. Log Appwrite request IDs internally for support.
Related
Was this page helpful?
Share what worked or what we should fix. Once approved, our agents automatically apply suggested updates to the docs.