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 Oversikt
|
|
info: Forstå de fire forskjellige APIene og når du skal bruke hver enkelt.
|
|
image: /images/user-guide/api/api-overview.png
|
|
sectionInfo: Lær hvordan du kobler Twenty til dine andre verktøy.
|
|
---
|
|
|
|
<Frame>
|
|
<img src="/images/user-guide/api/api-overview.png" alt="Header" />
|
|
</Frame>
|
|
|
|
Twenty ble laget for å være utviklervennlig, og tilbyr kraftige APIer som tilpasser seg din egentilpassede datamodell. Vi tilbyr fire distinkte API-typer for å møte forskjellige integrasjonsbehov.
|
|
|
|
## Utvikler-først-tilnærming
|
|
|
|
Twenty genererer APIer spesifikt for din datamodell, noe som betyr:
|
|
|
|
- **Ingen lange IDer kreves**: Bruk dine objekt- og feltnavn direkte i endepunkter
|
|
- **Standard- og egendefinerte objekter behandles likt**: Dine egendefinerte objekter får samme API-behandling som innebygde.
|
|
- **Dedikerte endepunkter**: Hvert objekt og felt får sitt eget API-endepunkt.
|
|
- **Egendefinert dokumentasjon**: Generert spesifikt for din arbeidsplass' datamodell.
|
|
|
|
<Warning>
|
|
Din egendefinerte API genererer personlig dokumentasjon som er tilgjengelig via Innstillinger → API & Webhooks etter å ha opprettet en API-nøkkel. Denne dokumentasjonen gjenspeiler din eksakte datamodell og feltkonfigurasjoner.
|
|
</Warning>
|
|
|
|
## De Fire API-Typene
|
|
|
|
Twenty tilbyr APIer i både **REST** og **GraphQL** formater:
|
|
|
|
### REST APIer
|
|
|
|
#### 1. REST Metadata API
|
|
|
|
- **Formål**: Administrere din arbeidsplass og datamodellstruktur.
|
|
- **Brukstilfeller**:
|
|
- Opprette, endre eller slette objekter og felter.
|
|
- Konfigurere innstillinger for arbeidsplassen.
|
|
- Administrere forhold i datamodellen.
|
|
- **Tilgang**: Tilgjengelig via REST-endepunkter.
|
|
|
|
#### 2. REST Core API
|
|
|
|
- **Formål**: Administrere dine faktiske dataposter.
|
|
- **Brukstilfeller**:
|
|
- Opprette, lese, oppdatere eller slette poster.
|
|
- Spørre etter spesifikke data.
|
|
- Administrere forhold mellom poster.
|
|
- **Tilgang**: Tilgjengelig via REST-endepunkter.
|
|
|
|
### GraphQL APIer
|
|
|
|
#### 3. GraphQL Metadata API
|
|
|
|
- **Formål**: Samme som REST Metadata API, men med GraphQL-fordeler.
|
|
- **Brukstilfeller**: Samme administrasjon av arbeidsplass og datamodell.
|
|
- **Ytterligere fordeler**:
|
|
- Spørre flere metadata-typer i én forespørsel.
|
|
- Nøyaktig feltvalg.
|
|
- Bedre ytelse for komplekse forespørsler.
|
|
|
|
#### 4. GraphQL Core API
|
|
|
|
- **Formål**: Samme som REST Core API, men med GraphQL-fordeler.
|
|
- **Brukstilfeller**: Samme administrasjon av dataoppføringer.
|
|
- **Ytterligere fordeler**:
|
|
- **Batch-operasjoner**: Tilgjengelig for alle operasjoner.
|
|
- **Upsert-operasjoner**: Opprett eller oppdater poster i én samtale.
|
|
- Spørre relasjoner i enkle forespørsler.
|
|
- Nøyaktig datauthenting.
|
|
|
|
## Batch-operasjoner
|
|
|
|
### REST- og GraphQL-batchstøtte
|
|
|
|
Både REST og GraphQL APIene støtter batch-operasjoner for de fleste handlinger:
|
|
|
|
- **Batch-størrelse**: Opp til 60 registreringer per forespørsel.
|
|
- **Tilgjengelige operasjoner**: Opprette, oppdatere, slette flere registreringer.
|
|
- **Ytelse**: Betydelig raskere enn individuelle API-anrop.
|
|
|
|
### GraphQL-Only Funksjoner
|
|
|
|
- **Batch Upsert**: Kun tilgjengelig i GraphQL APIer.
|
|
- **Bruk**: Bruk pluralobjektnavn (f.eks., `CreateCompanies` i stedet for `CreateCompany`).
|
|
- **Krav**: Dette er hvorfor entalls- og flertallsobjektnavn må være ulike.
|
|
|
|
## API Dokumenttilgang
|
|
|
|
1. Gå til **Innstillinger → API & Webhooks**
|
|
2. Opprett en API-nøkkel (nødvendig for dokumentasjonstilgang).
|
|
3. Tilgang til din egendefinerte dokumentasjon og lekeplass.
|
|
4. Test APIene med din faktiske datamodell.
|
|
|
|
Din dokumentasjon er unik for din arbeidsplass fordi den gjenspeiler dine egendefinerte objekter, felter og relasjoner.
|
|
|
|
## Når du skal bruke hver API
|
|
|
|
### Bruk Metadata API-er når:
|
|
|
|
- Sette opp din datamodell.
|
|
- Opprette egendefinerte objekter eller felter.
|
|
- Konfigurere innstillinger for arbeidsplassen.
|
|
|
|
### Bruk Core API-er når:
|
|
|
|
- Administrere dagligdagse data (Personer, Selskaper, Muligheter).
|
|
- Integrere med eksterne systemer.
|
|
- Bygge egendefinerte applikasjoner.
|
|
- Automatisere dataarbeidsflyter.
|
|
|
|
### Velg GraphQL når:
|
|
|
|
- Du trenger batch-operasjoner.
|
|
- Du vil minimere API-anrop.
|
|
- Du trenger upsert-funksjonalitet.
|
|
- Du bygger komplekse integrasjoner.
|
|
|
|
### Velg REST når:
|
|
|
|
- Du foretrekker en enklere API-struktur.
|
|
- Du bygger grunnleggende integrasjoner.
|
|
- Teamet ditt er mer kjent med REST.
|
|
- Du trenger enkle CRUD-operasjoner.
|
|
|
|
## Neste steg
|
|
|
|
- **[API & Webhooks Oppsett](/l/no/user-guide/integrations-api/api-webhooks)**: Lær hvordan du oppretter API-nøkler og webhooks.
|
|
- **Egendefinert dokumentasjon**: Tilgang din personlige API-dokumentasjon via Innstillinger → API & Webhooks.
|
|
|