Skip to content

Improve content of API overviews page #132

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 1 commit into from
Sep 30, 2023
Merged

Improve content of API overviews page #132

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions src/routes/docs/references/+page.markdoc
View file
Open in desktop
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##-login).
Copy link
Contributor Author

@gewenyu99 gewenyu99 Sep 29, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Client APIs require an active session, created from [signing up and logging in](/docs/products/auth/accounts##-login).
Some Client APIs require an active session created from [signing up and logging in](/docs/products/auth/accounts##-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