github-actions[bot]
9bc5486d0d
Created by Github action --------- Co-authored-by: github-actions <github-actions@twenty.com>
131 lines
4.5 KiB
Plaintext
131 lines
4.5 KiB
Plaintext
---
|
|
title: API Oversigt
|
|
info: Forstå de fire forskellige API'er, og hvornår man skal bruge hver enkelt.
|
|
image: /images/user-guide/api/api-overview.png
|
|
sectionInfo: Lær hvordan du forbinder Twenty til dine andre værktøjer.
|
|
---
|
|
|
|
<Frame>
|
|
<img src="/images/user-guide/api/api-overview.png" alt="Header" />
|
|
</Frame>
|
|
|
|
Twenty blev bygget til at være udviklervenlig, med kraftfulde API'er der tilpasses din brugerdefinerede datamodel. Vi leverer fire forskellige API-typer til at imødekomme forskellige integrationsbehov.
|
|
|
|
## Udvikler-første tilgang
|
|
|
|
Twenty genererer API'er specielt til din datamodel, hvilket betyder:
|
|
|
|
- **Ingen lange ID'er kræves**: Brug dine objekt- og feltnavne direkte i endpoints
|
|
- **Standard- og brugerdefinerede objekter behandles ens**: Dine brugerdefinerede objekter får samme API-behandling som indbyggede
|
|
- **Dedicated endpoints**: Each object and field gets its own API endpoint
|
|
- **Brugerdefineret dokumentation**: Genereret specifikt til din arbejdsplads' datamodel
|
|
|
|
<Warning>
|
|
Din brugerdefinerede API genererer personlig dokumentation tilgængelig via Indstillinger → API & Webhooks efter oprettelse af en API-nøgle. Denne dokumentation afspejler din nøjagtige datamodel og feltskonfigurationer.
|
|
</Warning>
|
|
|
|
## De fire API-typer
|
|
|
|
Twenty tilbyder API'er i både **REST** og **GraphQL** formater:
|
|
|
|
### REST API'er
|
|
|
|
#### 1. REST Metadata API
|
|
|
|
- **Formål**: Administrer din arbejdsplads og datamodelstruktur
|
|
- **Brugssager**:
|
|
- Opret, modificer, eller slet objekter og felter
|
|
- Konfigurer arbejdspladsindstillinger
|
|
- Administrer datamodelforhold
|
|
- **Adgang**: Tilgængelig gennem REST-endpoints
|
|
|
|
#### 2. REST Core API
|
|
|
|
- **Formål**: Administrer dine faktiske dataregistre
|
|
- **Brugssager**:
|
|
- Opret, læs, opdater, slet registreringer
|
|
- Forespørg specifikke data
|
|
- Administrer registreringsforhold
|
|
- **Adgang**: Tilgængelig gennem REST-endpoints
|
|
|
|
### GraphQL API'er
|
|
|
|
#### 3. GraphQL Metadata API
|
|
|
|
- **Formål**: Samme som REST Metadata API men med GraphQL-fordele
|
|
- **Brugssager**: Samme arbejdsplads- og datamodeladministration
|
|
- **Yderligere fordele**:
|
|
- Forespørg flere metadata-typer i én anmodning
|
|
- Præcis feltvalg
|
|
- Bedre ydeevne for komplekse forespørgsler
|
|
|
|
#### 4. GraphQL Core API
|
|
|
|
- **Formål**: Samme som REST Core API men med GraphQL-fordele
|
|
- **Brugssager**: Samme dataregistreringsadministration
|
|
- **Yderligere fordele**:
|
|
- **Batch-operationer**: Tilgængelige for alle operationer
|
|
- **Upsert-operationer**: Opret eller opdater registreringer i én anmodning
|
|
- Forespørg forhold i enkelte anmodninger
|
|
- Præcis dataindhentning
|
|
|
|
## Batch-operationer
|
|
|
|
### REST og GraphQL Batch-understøttelse
|
|
|
|
Både REST og GraphQL API'er understøtter batch-operationer for de fleste handlinger:
|
|
|
|
- **Batch-størrelse**: Op til 60 registreringer pr. anmodning
|
|
- **Tilgængelige operationer**: Opret, opdater, slet flere registreringer
|
|
- **Ydeevne**: Betydeligt hurtigere end individuelle API-kald
|
|
|
|
### Kun GraphQL-funktioner
|
|
|
|
- **Batch Upsert**: Kun tilgængelig i GraphQL API'er
|
|
- **Anvendelse**: Brug plural objekt-navne (f.eks., `CreateCompanies` i stedet for `CreateCompany`)
|
|
- **Krav**: Dette er grunden til at ental og flertal objekt-navne skal være adskilte
|
|
|
|
## API Dokumentationsadgang
|
|
|
|
1. Gå til **Indstillinger → API & Webhooks**
|
|
2. Opret en API-nøgle (påkrævet for tilgang til dokumentation)
|
|
3. Tilgå din brugerdefinerede dokumentation og legeplads
|
|
4. Test API'er med din faktiske datamodel
|
|
|
|
Din dokumentation er unik for din arbejdsplads, fordi den afspejler dine brugerdefinerede objekter, felter og forhold.
|
|
|
|
## Hvornår man skal bruge hver API
|
|
|
|
### Brug Metadata API'er når:
|
|
|
|
- Opsætning af din datamodel
|
|
- Oprettelse af brugerdefinerede objekter eller felter
|
|
- Konfiguration af arbejdspladsindstillinger
|
|
|
|
### Brug Core API'er når:
|
|
|
|
- Administrerer dag-til-dag data (personer, virksomheder, muligheder)
|
|
- Integration med eksterne systemer
|
|
- Bygger brugerdefinerede applikationer
|
|
- Automating data workflows
|
|
|
|
### Vælg GraphQL når:
|
|
|
|
- Du har brug for batch-operationer
|
|
- Du vil minimere API-kald
|
|
- Du har brug for upsert-funktionalitet
|
|
- Du bygger komplekse integrationer
|
|
|
|
### Vælg REST når:
|
|
|
|
- Du foretrækker en enklere API-struktur
|
|
- Du laver grundlæggende integrationer
|
|
- Dit team er mere fortrolig med REST
|
|
- Du har brug for ligetil CRUD-operationer
|
|
|
|
## Next Steps
|
|
|
|
- **[API & Webhooks Opsætning](/l/da/user-guide/integrations-api/api-webhooks)**: Lær hvordan du opretter API-nøgler og webhooks
|
|
- **Brugerdefineret Dokumentation**: Tilgå dine personlige API-dokumenter via Indstillinger → API & Webhooks
|
|
|