Skip to content

Commit

Permalink
Merge pull request #132 from appwrite/feat-add-api-info
Browse files Browse the repository at this point in the history
  • Loading branch information
TorstenDittmann authored Sep 30, 2023
2 parents d49d7c5 + 0e2ddb5 commit 62dd54b
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions src/routes/docs/references/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,28 @@ layout: article
title: References
description: Complete API references for Appwrite SDK, REST, and GraphQL APIs. Learn how to use Authentication, Databases, Storage, Functions, Avatars, Locale, and other Appwrite APIs.
---
Appwrite lets you build integrations on web, mobile, native, and server platforms through a set of APIs. You can use one of our many SDKs or integrate directly through the REST API or GraphQL API.
Appwrite lets you build integrations on web, mobile, native, and server platforms through a set of APIs. You can use one of our many [SDKs](/docs/sdks) or integrate directly through the [REST API](/docs/apis/rest) or [GraphQL API](/docs/apis/graphql).

## Client vs Server APIs {% #client-vs-server %}

Client APIs and SDKs are for integrating with Appwrite to build client-based applications and websites.
They're authenticated with sessions and operate within the permissions granted to the user account used to create the session.
Client APIs only give access to resources if users have been [granted permissions](/docs/advanced/platform/permissions).

Server API and SDKs are for integrating with Appwrite to build backend or server applications.
They're authenticated with API keys and are constrained by scope, ignoring user permissions.
Server APIs are constrained by an [API key's](/docs/advanced/platform/api-keys) scope, ignoring user permissions.

Choose the appropriate API and SDK for your use case.
## APIs {% #api %}
Before using the Appwrite APIs, in the **Settings** of your Appwrite project, obtain your **API endpoint** and **Project ID**.
Client APIs require an active session, created from [signing up and logging in](/docs/products/auth/accounts#signup-login).
Server APIs require [API keys](/docs/advanced/platform/api-keys).

[Learn about SDKs {% icon icon="cheveron-right" /%}](/docs/sdks)

## APIs {% #api %}
{% only_dark %}
![Project settings screen](/images/docs/quick-starts/dark/project-id.png)
{% /only_dark %}
{% only_light %}
![Project settings screen](/images/docs/quick-starts/project-id.png)
{% /only_light %}

{% cards %}
{% cards_item href="/docs/references/cloud/client-web/account" title="Account" %}
Expand Down

0 comments on commit 62dd54b

Please sign in to comment.