github-actions[bot]
9bc5486d0d
Created by Github action --------- Co-authored-by: github-actions <github-actions@twenty.com>
131 lines
7.1 KiB
Plaintext
131 lines
7.1 KiB
Plaintext
---
|
||
title: APIs Overview
|
||
info: Зрозумійте чотири різні API і коли використовувати кожен з них.
|
||
image: /images/user-guide/api/api-overview.png
|
||
sectionInfo: Дізнайтеся, як підключити Twenty до ваших інших інструментів.
|
||
---
|
||
|
||
<Frame>
|
||
<img src="/images/user-guide/api/api-overview.png" alt="Header" />
|
||
</Frame>
|
||
|
||
Twenty було створено для зручності розробника, пропонуючи потужні API, які адаптуються до вашої налаштованої моделі даних. Ми пропонуємо чотири окремих типи API для задоволення різноманітних інтеграційних потреб.
|
||
|
||
## Developer-First Approach
|
||
|
||
Twenty generates APIs specifically for your data model, meaning:
|
||
|
||
- **Довгі ID не потрібні**: Використовуйте назви об'єктів та полів безпосередньо в кінцевих точках
|
||
- **Стандартні та налаштовані об'єкти обробляються однаково**: Ваші об'єкти, налаштовані вами, отримують таку ж API обробку, як і вбудовані
|
||
- **Dedicated endpoints**: Each object and field gets its own API endpoint
|
||
- **Custom documentation**: Generated specifically for your workspace's data model
|
||
|
||
<Warning>
|
||
Your custom API generates personalized documentation accessible via Settings → API & Webhooks after creating an API key. Ця документація відображає вашу точну модель даних і конфігурації полів.
|
||
</Warning>
|
||
|
||
## Чотири типи API
|
||
|
||
Twenty пропонує API у форматах **REST** і **GraphQL**:
|
||
|
||
### REST APIs
|
||
|
||
#### 1. REST Metadata API
|
||
|
||
- **Призначення**: Управляти структурою вашого робочого середовища і моделі даних
|
||
- **Випадки застосування**:
|
||
- Створювати, змінювати або видаляти об'єкти та поля
|
||
- Налаштування робочого середовища
|
||
- Управління відносинами моделі даних
|
||
- **Доступ**: Доступно через REST кінцеві точки
|
||
|
||
#### 2. REST Core API
|
||
|
||
- **Призначення**: Управляти вашими реальними записами даних
|
||
- **Випадки застосування**:
|
||
- Створення, читання, оновлення, видалення записів
|
||
- Запит специфічних даних
|
||
- Управління відносинами записів
|
||
- **Доступ**: Доступно через REST кінцеві точки
|
||
|
||
### GraphQL APIs
|
||
|
||
#### 3. GraphQL Metadata API
|
||
|
||
- **Призначення**: Те ж, що і REST Metadata API, але з перевагами GraphQL
|
||
- **Випадки застосування**: Те ж управління робочим середовищем і моделлю даних
|
||
- **Додаткові переваги**:
|
||
- Запит декількох типів метаданих в одному запиті
|
||
- Точний вибір полів
|
||
- Краща продуктивність для складних запитів
|
||
|
||
#### 4. GraphQL Core API
|
||
|
||
- **Призначення**: Те ж, що і REST Core API, але з перевагами GraphQL
|
||
- **Випадки застосування**: Те ж управління записами даних
|
||
- **Додаткові переваги**:
|
||
- **Поблочні операції**: Доступно для всіх операцій
|
||
- **Upsert operations**: Create or update records in one call
|
||
- Query relationships in single requests
|
||
- Точне отримання даних
|
||
|
||
## Поблочні операції
|
||
|
||
### Підтримка поблочних операцій у формати REST та GraphQL
|
||
|
||
Обидва REST і GraphQL API підтримують поблочні операції для більшості дій:
|
||
|
||
- **Розмір блоку**: До 60 записів на один запит
|
||
- **Доступні операції**: Створюйте, оновлюйте, видаляйте кілька записів
|
||
- **Продуктивність**: Значно швидше, ніж індивідуальні виклики API
|
||
|
||
### Особливості тільки для GraphQL
|
||
|
||
- **Batch Upsert**: Доступно тільки в GraphQL API
|
||
- **Використання**: Використовуйте назви об'єктів у множині (наприклад, `CreateCompanies` замість `CreateCompany`)
|
||
- **Вимога**: Ось чому назви об'єктів в однині та множині повинні бути різними
|
||
|
||
## Доступ до документації по API
|
||
|
||
1. Перейдіть до **Settings → API & Webhooks**
|
||
2. Створіть ключ API (вимагається для доступу до документації)
|
||
3. Отримайте доступ до вашої налаштованої документації та тестового середовища
|
||
4. Тестуйте APIs з вашою фактичною моделлю даних
|
||
|
||
Ваша документація унікальна для вашого робочого середовища, оскільки вона відображає ваші налаштовані об'єкти, поля та відносини.
|
||
|
||
## Коли використовувати кожен API
|
||
|
||
### Використовуйте Metadata APIs, коли:
|
||
|
||
- Налаштовуєте вашу модель даних
|
||
- Створюєте налаштовані об'єкти або поля
|
||
- Налаштування робочого середовища
|
||
|
||
### Використовуйте Core APIs, коли:
|
||
|
||
- Управляєте щоденними даними (Люди, Компанії, Можливості)
|
||
- Інтегруєтеся з зовнішніми системами
|
||
- Створюєте налаштовані додатки
|
||
- Automating data workflows
|
||
|
||
### Вибирайте GraphQL, коли:
|
||
|
||
- Ви потребуєте поблочні операції
|
||
- Ви хочете мінімізувати виклики API
|
||
- Вам потрібна функціональність upsert
|
||
- Ви будуєте складні інтеграції
|
||
|
||
### Вибирайте REST, коли:
|
||
|
||
- Ви надаєте перевагу простішій структурі API
|
||
- Ви будуєте базові інтеграції
|
||
- Ваша команда більш знайома з REST
|
||
- Вам потрібні прості CRUD операції
|
||
|
||
## Наступні кроки
|
||
|
||
- **[Налаштування API & Webhooks](/l/uk/user-guide/integrations-api/api-webhooks)**: Дізнайтеся, як створити API ключі та webhooks
|
||
- **Налаштована документація**: Отримайте доступ до своїх персоналізованих API доків через Settings → API & Webhooks
|
||
|