github-actions[bot]
9bc5486d0d
Created by Github action --------- Co-authored-by: github-actions <github-actions@twenty.com>
131 lines
7.2 KiB
Plaintext
131 lines
7.2 KiB
Plaintext
---
|
||
title: Преглед API-ја
|
||
info: Разумите четири различита API-a и када да користите сваки од њих.
|
||
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 генерише API-е специфично за ваш модел података, што значи:
|
||
|
||
- **Не захтевају се дуги ID-ови**: Користите имена ваших објеката и поља директно у крајњим тачкама
|
||
- **Стандардни и прилагођени објекти се третирају једнако**: Ваши прилагођени објекти добијају исто API третирање као и уграђени објекти
|
||
- **Dedicated endpoints**: Each object and field gets its own API endpoint
|
||
- **Прилагођена документација**: Генерисана конкретно за модел података вашег радног простора
|
||
|
||
<Warning>
|
||
Ваш прилагођени API генерише персонализовану документацију приступачну преко Поставке → API & Webhooks после креирања API кључа. Ова документација одражава ваш тачан модел података и конфигурације поља.
|
||
</Warning>
|
||
|
||
## Четири типа API-а
|
||
|
||
Twenty нуди API-е у оба **REST** и **GraphQL** формата:
|
||
|
||
### REST API-и
|
||
|
||
#### 1. REST Метаподаци API
|
||
|
||
- **Сврха**: Управљајте структуром вашег радног простора и модела података
|
||
- **Случајеви употребе**:
|
||
- Креирање, измена или брисање објеката и поља
|
||
- Конфигуришите поставке вашег радног простора
|
||
- Управљајте односима модела података
|
||
- **Приступ**: Доступно преко REST крајњих тачака
|
||
|
||
#### 2. REST Језгро API
|
||
|
||
- **Сврха**: Управљајте вашим стварним записима података
|
||
- **Случајеви употребе**:
|
||
- Креирање, читање, ажурирање, брисање записа
|
||
- Упитивање специфичних података
|
||
- Управљање односима записа
|
||
- **Приступ**: Доступно преко REST крајњих тачака
|
||
|
||
### GraphQL API-и
|
||
|
||
#### 3. GraphQL Метаподаци API
|
||
|
||
- **Сврха**: Иста као и REST Метаподаци API али са предностима GraphQL-а
|
||
- **Случајеви употребе**: Исто управљање радним простором и моделом података
|
||
- **Додатне предности**:
|
||
- Упитивање више типова метаподатака у једном захтеву
|
||
- Прецизан избор поља
|
||
- Боља изведба за сложене упите
|
||
|
||
#### 4. GraphQL Језгро API
|
||
|
||
- **Сврха**: Иста као и REST Језгро API али са предностима GraphQL-а
|
||
- **Случајеви употребе**: Исто управљање записима података
|
||
- **Додатне предности**:
|
||
- **Бач операције**: Доступно за све операције
|
||
- **Упсерт операције**: Креира или ажурира записе у једном позиву
|
||
- Упит односима у једном захтеву
|
||
- Прецизно преузимање података
|
||
|
||
## Бач операције
|
||
|
||
### REST и GraphQL подршка за бач
|
||
|
||
Оба API-а (REST и GraphQL) подржавају бач операције за већину акција:
|
||
|
||
- **Величина бата**: До 60 записа по захтеву
|
||
- **Доступне операције**: Креирање, ажурирање, брисање више записа
|
||
- **Изведба**: Знатно брже од појединачних API позива
|
||
|
||
### GraphQL-Само Функције
|
||
|
||
- **Бач Упсерт**: Доступно само у GraphQL API-има
|
||
- **Употреба**: Користите многа имена објеката (нпр. `CreateCompanies` уместо `CreateCompany`)
|
||
- **Захтев**: Зато су различита појединачна и многа имена објеката неопходна
|
||
|
||
## Приступ Документацији API-а
|
||
|
||
1. Идите у **Поставке → API & Webhooks**
|
||
2. Креирајте API кључ (потребан за приступ документацији)
|
||
3. Приступите вашој персонализованој документацији и игралишту
|
||
4. Тестирајте API-е са вашим стварним моделом података
|
||
|
||
Ваша документација је јединствена за ваш радни простор јер одражава ваше прилагођене објекте, поља и односе.
|
||
|
||
## Када користити сваки API
|
||
|
||
### Користите Метаподаци API када:
|
||
|
||
- Постављате ваш модел података
|
||
- Креирање прилагођених објеката или поља
|
||
- Конфигуришите поставке радног простора
|
||
|
||
### Користите Језгро API када:
|
||
|
||
- Управљање свакодневним подацима (Људи, Компаније, Прилике)
|
||
- Интеграција са спољним системима
|
||
- Изградња прилагођених апликација
|
||
- Аутоматска обрада података
|
||
|
||
### Изаберите GraphQL када:
|
||
|
||
- Потребне су вам бач операције
|
||
- Желите да минимизирате API позиве
|
||
- Потребна вам је упсерт функционалност
|
||
- Градите сложене интеграције
|
||
|
||
### Изаберите REST када:
|
||
|
||
- You prefer simpler API structure
|
||
- You're building basic integrations
|
||
- Ваш тим је више упознат са REST
|
||
- Потребне су вам једноставне CRUD операције
|
||
|
||
## Next Steps
|
||
|
||
- **[Постављање API-а и Webhook-а](/l/sr/user-guide/integrations-api/api-webhooks)**: Научите како да креирате API кључеве и webhook-ове
|
||
- **Прилагођена документација**: Приступите својој персонализованој API документацији преко Поставке → API & Webhooks
|
||
|