github-actions[bot]
9bc5486d0d
Created by Github action --------- Co-authored-by: github-actions <github-actions@twenty.com>
131 lines
4.3 KiB
Plaintext
131 lines
4.3 KiB
Plaintext
---
|
|
title: APIs Overview
|
|
info: Begryp die vier verskillende API's en wanneer om elkeen te gebruik.
|
|
image: /images/user-guide/api/api-overview.png
|
|
sectionInfo: Leer hoe om Twenty aan jou ander gereedskap te koppel.
|
|
---
|
|
|
|
<Frame>
|
|
<img src="/images/user-guide/api/api-overview.png" alt="Header" />
|
|
</Frame>
|
|
|
|
Twenty is ontwikkel om vriendelik vir ontwikkelaars te wees, met kragtige API's wat by jou pasgemaakte datamodel aanpas. Ons verskaf vier verskillende API-tipes vir verskillende integrasiebehoeftes.
|
|
|
|
## Developer-First Approach
|
|
|
|
Twenty genereer API's spesifiek vir jou datamodel, wat beteken:
|
|
|
|
- **Geen lang ID's nodig nie**: Gebruik jou objek- en veldname direk in eindpunte
|
|
- **Standaard en pasgemaakte voorwerpe word gelykop behandel**: Jou pasgemaakte voorwerpe kry dieselfde API-behandeling as ingeboude
|
|
- **Toegewyde eindpunte**: Elke voorwerp en veld kry sy eie API-eindpunt
|
|
- **Pasgemaakte dokumentasie**: Spesifiek gegenereer vir jou werksruimte se datamodel
|
|
|
|
<Warning>
|
|
Jou pasgemaakte API genereer persoonlike dokumentasie wat toeganklik is via Instellings → API en Webhooks ná die skep van 'n API-sleutel. Hierdie dokumentasie weerspieël jou presiese datamodel en veldkonfigurasies.
|
|
</Warning>
|
|
|
|
## Die Vier API-tipes
|
|
|
|
Twenty bied API's in beide **REST** en **GraphQL** formaat aan:
|
|
|
|
### REST API's
|
|
|
|
#### 1. REST Metadata API
|
|
|
|
- **Doel**: Bestuur jou werksruimte en datamodelstruktuur
|
|
- **Gebruik gevalle**:
|
|
- Skep, wysig of verwyder voorwerpe en velde
|
|
- Stel werksruimte-instettings in
|
|
- Bestuur datamodelverhoudings
|
|
- **Toegang**: Beskikbaar deur REST-eindpunte
|
|
|
|
#### 2. REST Kern API
|
|
|
|
- **Doel**: Bestuur jou werklike databestande
|
|
- **Gebruik gevalle**:
|
|
- Skep, lees, wysig, verwyder rekords
|
|
- Navraag spesifieke data
|
|
- Bestuur rekordverhoudings
|
|
- **Toegang**: Beskikbaar deur REST-eindpunte
|
|
|
|
### GraphQL API's
|
|
|
|
#### 3. GraphQL Metadata API
|
|
|
|
- **Doel**: Dieselfde as REST Metadata API maar met GraphQL voordele
|
|
- **Gebruik gevalle**: Dieselfde werksruimte en datamodelbestuur
|
|
- **Bykomende voordele**:
|
|
- Navraag veelvuldige metadata tipes in een versoek
|
|
- Presiese veldseleksie
|
|
- Beter prestasie vir komplekse navrae
|
|
|
|
#### 4. GraphQL Kern API
|
|
|
|
- **Doel**: Dieselfde as REST Kern API maar met GraphQL voordele
|
|
- **Gebruik gevalle**: Dieselfde databestuur
|
|
- **Bykomende voordele**:
|
|
- **Batch werksaamhede**: Beskikbaar vir alle werksaamhede
|
|
- **Upsert werksaamhede**: Skep of werk rekords op in een oproep
|
|
- Navraag verhoudings in enkele versoeke
|
|
- Presiese data-verkryging
|
|
|
|
## Batch Werksaamhede
|
|
|
|
### REST en GraphQL Batch Ondersteuning
|
|
|
|
Beide REST en GraphQL API's ondersteun batch werksaamhede vir meeste aksies:
|
|
|
|
- **Batch grootte**: Tot 60 rekords per versoek
|
|
- **Beskikbare werksaamhede**: Skep, werk op, verwyder veelvuldige rekords
|
|
- **Prestasie**: Aansienlik vinniger as individuele API-oproepe
|
|
|
|
### Slegs GraphQL-kenmerke
|
|
|
|
- **Batch Upsert**: Slegs beskikbaar in GraphQL API's
|
|
- **Gebruik**: Gebruik meervoudige objekname (bv. `Skepmaatskappye` in plaas van `Skepmaatskappy`)
|
|
- **Vereiste**: Dit is waarom enkelvoudige en meervoudige objekname moet verskil
|
|
|
|
## API Dokumentasie Toegang
|
|
|
|
1. Gaan na **Instellings → API en Webhooks**
|
|
2. Skep 'n API-sleutel (vereis vir dokumentasie toegang)
|
|
3. Toegang tot jou pasgemaakte dokumentasie en speelgrond
|
|
4. Toets API's met jou werklike datamodel
|
|
|
|
Jou dokumentasie is uniek aan jou werksruimte omdat dit jou pasgemaakte voorwerpe, velde en verhoudings weerspieël.
|
|
|
|
## Wanneer om elke API te gebruik
|
|
|
|
### Gebruik Metadata API's wanneer:
|
|
|
|
- Instelling van jou datamodel
|
|
- Skep pasgemaakte voorwerpe of velde
|
|
- Konfigurasie van werksruimte-instellings
|
|
|
|
### Gebruik Kern API's wanneer:
|
|
|
|
- Bestuur van daaglikse data (Mense, Maatskappye, Geleenthede)
|
|
- Integrasie met eksterne stelsels
|
|
- Bou van pasgemaakte toepassings
|
|
- Outomatisering van data werkvloei
|
|
|
|
### Kies GraphQL wanneer:
|
|
|
|
- Jy het batch werksaamhede nodig
|
|
- Jy wil API-oproepe verminder
|
|
- Jy opsert funksionaliteit benodig
|
|
- Jy bou komplekse integrasies
|
|
|
|
### Kies REST wanneer:
|
|
|
|
- Jy verkies 'n eenvoudiger API-struktuur
|
|
- Jy bou basiese integrasies
|
|
- Jou span is meer vertroud met REST
|
|
- Jy het direkte CRUD werksaamhede nodig
|
|
|
|
## Volgende Stap
|
|
|
|
- **[API & Webhooks Opstelling](/l/af/user-guide/integrasies-api/api-webhooks)**: Leer hoe om API-sleutels en webhooks te skep
|
|
- **Pasgemaakte Dokumentasie**: Verkry jou persoonlike API-dokumente via Instellings → API en Webhooks
|
|
|