8cadd00d34
Created by Github action --------- Co-authored-by: Crowdin Bot <support+bot@crowdin.com> Co-authored-by: github-actions <github-actions@twenty.com>
56 lines
5.5 KiB
Plaintext
56 lines
5.5 KiB
Plaintext
---
|
||
title: API
|
||
image: /images/docs/getting-started/api.png
|
||
info: Узнайте, как использовать наши API.
|
||
---
|
||
|
||
<Frame>
|
||
<img src="/images/docs/getting-started/api.png" alt="Header" />
|
||
</Frame>
|
||
|
||
## Обзор
|
||
|
||
Twenty API позволяет разработчикам программно взаимодействовать с платформой Twenty CRM. С помощью API вы можете интегрировать Twenty с другими системами, автоматизировать синхронизацию данных и создавать пользовательские решения на основе данных о ваших клиентах. API предоставляет конечные точки для **создания, чтения, обновления и удаления** основных объектов CRM (таких как люди и компании), а также доступ к настройке метаданных.
|
||
|
||
**API Playground:** You can now access the API Playground within the app's settings. To try out API calls in real-time, log in to your Twenty workspace and navigate to **Settings → APIs & Webhooks**. This opens the in-app API Playground and the settings for API keys.
|
||
**[Перейти к настройкам API](https://app.twenty.com/settings)**
|
||
|
||
## Аутентификация
|
||
|
||
API Twenty использует ключи API для аутентификации. Каждый запрос к защищённым конечным точкам должен содержать ключ API в заголовке.
|
||
|
||
- **Ключи API:** вы можете сгенерировать новый ключ API в разделе **настройки API** вашего приложения Twenty. Each API key is a secret token that grants access to your CRM data, so keep it safe. Если ключ скомпрометирован, отозовите его в настройках и создайте новый.
|
||
- **Заголовок для аутентификации:** как только у вас будет ключ API, включите его в заголовок `Authorization` ваших HTTP-запросов. Используйте схему токена Bearer. Например:
|
||
|
||
```
|
||
Authorization: Bearer YOUR_API_KEY
|
||
```
|
||
|
||
Замените `YOUR_API_KEY` на полученный вами ключ. Этот заголовок должен присутствовать во **всех запросах API**. Если токен отсутствует или недействителен, API ответит ошибкой аутентификации (HTTP 401 Unauthorized).
|
||
|
||
## Конечные точки API
|
||
|
||
Все ресурсы доступны через REST или GraphQL.
|
||
|
||
- **Облако:** `https://api.twenty.com/` или ваш собственный домен/поддомен
|
||
- **Self-Hosted Instances:** If you are running Twenty on your own server, use your own domain in place of `api.twenty.com` (for example, `https://{your-domain}/rest/`).
|
||
|
||
Конечные точки сгруппированы в две категории: **Основной API** и **API метаданных**. **Основной API** работает с основными данными CRM (например, люди, компании, заметки, задачи), тогда как **API метаданных** охватывает данные настройки (такие как пользовательские поля или определения объектов). Большинство интеграций будут в первую очередь использовать Основной API.
|
||
|
||
### Основной API
|
||
|
||
Доступен на `/rest/` или `/graphql/`.
|
||
**Основной API** служит унифицированным интерфейсом для управления основными сущностями CRM (люди, компании, заметки, задачи) и их отношениями, предлагая **как REST, так и GraphQL** модели взаимодействия.
|
||
|
||
### API метаданных
|
||
|
||
Доступен на `/rest/metadata/` или `/metadata/`.
|
||
Конечные точки API метаданных позволяют вам получить информацию о вашей схеме и настройках. Например, вы можете получить определения пользовательских полей, схем объектов и т.д.
|
||
|
||
- **Примеры конечных точек:**
|
||
|
||
- `GET /rest/metadata/objects` – Список всех типов объектов и их метаданных (поля, отношения).
|
||
- `GET /rest/metadata/objects/{objectName}` – Получение метаданных для конкретного объекта (например, `люди`, `компании`).
|
||
- `GET /rest/metadata/picklists` – Получение опций поля списка (выпадающего), определённых в CRM.
|
||
|
||
Конечные точки метаданных обычно используются для понимания структуры данных (для динамической интеграции или построения форм), а не для управления фактическими записями. В большинстве случаев они только для чтения. Аутентификация также требуется для них (используйте ваш ключ API). |