Quick start

Under Add a platform, add a platform for each web, mobile, and native app you plan to create. This means, a different platform for each web app hosted under a different domain, and a different platform for each mobile or native app that use a different package ID.

You can skip optional steps.

Under Integrate with your server, add an API Key.

Enable the scopes for the Appwrite products you plan to use for your app. It's a good idea to only grant scopes that you need, and edit the API keys as your needs change for security.

Under Integrate with your server, add an API Key with the following scopes.

Client apps need to be configured with endpoint and project ID, so the Appwrite SDK knows which endpoint and project to connect to.

import { Client } from "appwrite";

const client = new Client();

client
    .setEndpoint('https://cloud.appwrite.io/v1')    // Your API Endpoint
    .setProject('<PROJECT_ID>')                // Your project ID
;

Server apps need to be configured with endpoint, project ID, and an API key so the Appwrite SDK knows which endpoint and project to connect to, as well as have credentials to perform admin actions.

const sdk = require('node-appwrite');

// Init SDK
const client = new sdk.Client();

client
    .setEndpoint('https://cloud.appwrite.io/v1')                // Your API Endpoint
    .setProject('<PROJECT_ID>')                            // Your project ID
    .setJWT('<YOUR_API_KEY>')                                   // Your secret JSON Web Token
;

Appwrite uses Server SDKs for SSR apps. The initialization is different

Admin client

To initialize the admin client, we'll need to first generated an API key. The API key should have the following scope in order to perform authentication:

import { Client } from "node-appwrite"; // Using the server SDK

const adminClient = new Client()
    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<PROJECT_ID>')             // Your project ID
    .setKey('<YOUR_API_KEY>');                   // Your secret API key

It is important to use an API key, as this will allow your server requests to bypass rate limits. If you don't use an API key, your server will be rate limited as if it were a client from a single IP address.

Session client

The session client will be used to make requests to Appwrite on behalf of the end-user. It will be initialized with the session, usually stored within a cookie.

You should create a new client for each request and never share the client between requests.

const sessionClient = new Client()
    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<PROJECT_ID>');            // Your project ID

const session = req.cookies.session; // Get the session cookie from the request
if (session) {
    sessionClient.setSession(session);
}