github-actions[bot]
9bc5486d0d
Created by Github action --------- Co-authored-by: github-actions <github-actions@twenty.com>
131 lines
4.9 KiB
Plaintext
131 lines
4.9 KiB
Plaintext
---
|
|
title: API-k áttekintése
|
|
info: Understand the four different APIs and when to use each one.
|
|
image: /images/user-guide/api/api-overview.png
|
|
sectionInfo: Tudja meg, hogyan kapcsolja össze a Twenty-t más eszközeivel.
|
|
---
|
|
|
|
<Frame>
|
|
<img src="/images/user-guide/api/api-overview.png" alt="Header" />
|
|
</Frame>
|
|
|
|
A Twenty fejlesztőbarátnak lett tervezve, erőteljes API-kat kínál, amelyek alkalmazkodnak az egyedi adatmodelljéhez. Négy különálló API típust biztosítunk különböző integrációs igények kielégítésére.
|
|
|
|
## Fejlesztő-központú megközelítés
|
|
|
|
A Twenty kifejezetten az Ön adatmodelljére generál API-kat, ami azt jelenti:
|
|
|
|
- **Nincs szükség hosszú ID-kre**: Használja közvetlenül az objektum- és mezőneveket a végpontoknál
|
|
- **Az alapértelmezett és egyedi objektumok egyenlő elbánást élveznek**: Az egyedi objektumai ugyanazt az API-kezelést kapják, mint a beépítettek
|
|
- **Dedikált végpontok**: Minden objektum és mező saját API-végpontot kap
|
|
- **Egyedi dokumentáció**: Az Ön munkaterületének adatmodelljére szabva készül
|
|
|
|
<Warning>
|
|
Your custom API generates personalized documentation accessible via Settings → API & Webhooks after creating an API key. Ez a dokumentáció tükrözi az Ön pontos adatmodelljét és mezőkonfigurációit.
|
|
</Warning>
|
|
|
|
## A négy API típus
|
|
|
|
A Twenty **REST** és **GraphQL** formátumú API-kat kínál:
|
|
|
|
### REST API-k
|
|
|
|
#### 1. REST Metadata API
|
|
|
|
- **Célja**: A munkaterület és az adatmodell struktúrájának kezelése
|
|
- **Használati esetek**:
|
|
- Objektumok és mezők létrehozása, módosítása vagy törlése
|
|
- A munkaterület beállításainak konfigurálása
|
|
- Adatmodell kapcsolatok kezelése
|
|
- **Hozzáférés**: Elérhető a REST végpontokon keresztül
|
|
|
|
#### 2. REST Core API
|
|
|
|
- **Célja**: Az aktuális adatbejegyzések kezelése
|
|
- **Használati esetek**:
|
|
- Rekordok létrehozása, olvasása, frissítése, törlése
|
|
- Specifikus adatok lekérdezése
|
|
- Rekordkapcsolatok kezelése
|
|
- **Hozzáférés**: Elérhető a REST végpontokon keresztül
|
|
|
|
### GraphQL API-k
|
|
|
|
#### 3. GraphQL Metadat API
|
|
|
|
- **Célja**: Ugyanaz, mint a REST Metadat API, de GraphQL előnyökkel
|
|
- **Használati esetek**: Azonos munkaterület és adatmodell kezelés
|
|
- **További előnyök**:
|
|
- Több metaadat típus lekérdezése egy kéréssel
|
|
- Pontos mezőkiválasztás
|
|
- Jobb teljesítmény az összetett lekérdezéseknél
|
|
|
|
#### 4. GraphQL Core API
|
|
|
|
- **Célja**: Ugyanaz, mint a REST Core API, de GraphQL előnyökkel
|
|
- **Használati esetek**: Azonos adatbejegyzés kezelés
|
|
- **További előnyök**:
|
|
- **Batch műveletek**: Minden műveletre elérhető
|
|
- **Upsert műveletek**: Rekordok létrehozása vagy frissítése egy hívással
|
|
- Kapcsolatok lekérdezése egyetlen kérésben
|
|
- Pontos adatlekérések
|
|
|
|
## Batch műveletek
|
|
|
|
### REST és GraphQL kötegelt támogatás
|
|
|
|
Mind a REST, mind a GraphQL API-k támogatják a csoportos műveleteket a legtöbb esetben:
|
|
|
|
- **Csoportméret**: Legfeljebb 60 rekord kérésenként
|
|
- **Elérhető műveletek**: Több rekord létrehozása, frissítése, törlése
|
|
- **Teljesítmény**: Jelentősen gyorsabb, mint az egyedi API-hívások
|
|
|
|
### Kizárólag GraphQL funkciók
|
|
|
|
- **Kötegezett Upsert**: Csak a GraphQL API-kban érhető el
|
|
- **Használat**: Többes számú objektumnevek használata (pl. `CreateCompanies` a `CreateCompany` helyett)
|
|
- **Követelmény**: Ezért kell az egyes és többes számú objektumneveknek elkülönülniük
|
|
|
|
## API Dokumentáció elérése
|
|
|
|
1. Menj a **Beállítások → API és Webhooks** részhez
|
|
2. Hozzon létre egy API kulcsot (szükséges a dokumentáció hozzáféréshez)
|
|
3. Érje el egyéni dokumentációját és játszóterét
|
|
4. API-k tesztelése a tényleges adatmodelljével
|
|
|
|
A dokumentációja egyedi az Ön munkaterületére, mivel tükrözi az egyéni objektumokat, mezőket és kapcsolatokat.
|
|
|
|
## Mikor használja az egyes API-kat
|
|
|
|
### Metadata API-k használata, amikor:
|
|
|
|
- Az adatmodell beállítása
|
|
- Egyedi objektumok vagy mezők létrehozása
|
|
- Munkaterület beállítások konfigurálása
|
|
|
|
### Core API-k használata, amikor:
|
|
|
|
- A napi adatok kezelése (Emberek, Vállalatok, Lehetőségek)
|
|
- Külső rendszerek integrálása
|
|
- Egyedi alkalmazások építése
|
|
- Adatfolyamatok automatizálása
|
|
|
|
### GraphQL választása, amikor:
|
|
|
|
- Csomag műveletekre van szüksége
|
|
- API hívások minimalizálása
|
|
- Upsert funkcionalitásra van szüksége
|
|
- Összetett integrációkat épít
|
|
|
|
### REST választása, amikor:
|
|
|
|
- Egyszerűbb API struktúrát részesít előnyben
|
|
- Alap integrációkat épít
|
|
- A csapata ismerősebb a REST-tel
|
|
- Egyszerű CRUD műveletekre van szüksége
|
|
|
|
## Következő lépések
|
|
|
|
- **[API és Webhooks beállítása](/l/hu/user-guide/integrations-api/api-webhooks)**: Tanulja meg, hogyan hozhat létre API kulcsokat és webhooks-t
|
|
- **Egyedi dokumentáció**: Érje el személyre szabott API dokumentációját a Beállítások → API és Webhooks menüben
|
|
|