8cadd00d34
Created by Github action --------- Co-authored-by: Crowdin Bot <support+bot@crowdin.com> Co-authored-by: github-actions <github-actions@twenty.com>
56 lines
3.7 KiB
Plaintext
56 lines
3.7 KiB
Plaintext
---
|
||
title: API
|
||
image: /images/docs/getting-started/api.png
|
||
info: Ontdek hoe u onze API's kunt gebruiken.
|
||
---
|
||
|
||
<Frame>
|
||
<img src="/images/docs/getting-started/api.png" alt="Header" />
|
||
</Frame>
|
||
|
||
## Overzicht
|
||
|
||
De Twenty API stelt ontwikkelaars in staat om programmeermatig te communiceren met het Twenty CRM-platform. Met behulp van de API kun je Twenty integreren met andere systemen, gegevenssynchronisatie automatiseren en aangepaste oplossingen bouwen rond je klantgegevens. De API biedt eindpunten om **kern-CRM objecten te creëren, lezen, bijwerken en verwijderen** (zoals personen en bedrijven) en om toegang te krijgen tot metadataconfiguraties.
|
||
|
||
**API Playground:** Je kunt nu toegang krijgen tot de API Playground binnen de instellingen van de app. Om API-aanroepen in real-time uit te proberen, log in op je Twenty-werkruimte en navigeer naar **Instellingen → API's & Webhooks**. Dit opent de in-app API Playground en de instellingen voor API-sleutels.
|
||
**[Ga naar API-instellingen](https://app.twenty.com/settings)**
|
||
|
||
## Authenticatie
|
||
|
||
De API van Twenty gebruikt API-sleutels voor authenticatie. Elke aanvraag naar beveiligde eindpunten moet een API-sleutel in de header bevatten.
|
||
|
||
- **API-sleutels:** Je kunt een nieuwe API-sleutel genereren vanaf de **API-instellingen** pagina van je Twenty-app. Elke API-sleutel is een geheim token dat toegang verleent tot je CRM-gegevens, dus houd het veilig. Als een sleutel gecompromitteerd is, herroep het dan uit de instellingen en genereer een nieuwe.
|
||
- **Auth Header:** Zodra je een API-sleutel hebt, moet deze worden opgenomen in de `Authorization` header van je HTTP-verzoeken. Gebruik het Bearer token-schema. Bijvoorbeeld:
|
||
|
||
```
|
||
Authorization: Bearer YOUR_API_KEY
|
||
```
|
||
|
||
Vervang `YOUR_API_KEY` door de verkregen sleutel. Deze header moet aanwezig zijn in **alle API-aanvragen**. Als het token ontbreekt of ongeldig is, reageert de API met een authenticatiefout (HTTP 401 Niet Geautoriseerd).
|
||
|
||
## API Eindpunten
|
||
|
||
Alle bronnen kunnen worden benaderd via REST of GraphQL.
|
||
|
||
- **Cloud:** `https://api.twenty.com/` of je eigen domein / subdomein
|
||
- **Self-Hosted Instances:** If you are running Twenty on your own server, use your own domain in place of `api.twenty.com` (for example, `https://{your-domain}/rest/`).
|
||
|
||
Eindpunten zijn gegroepeerd in twee categorieën: **Kern-API** en **Metadata API**. De **Kern-API** behandelt primaire CRM-gegevens (bijvoorbeeld personen, bedrijven, notities, taken), terwijl de **Metadata API** configuratiegegevens omvat (zoals aangepaste velden of objectdefinities). De meeste integraties zullen voornamelijk de Kern-API gebruiken.
|
||
|
||
### Kern-API
|
||
|
||
Toegankelijk via `/rest/` of `/graphql/`.
|
||
De **Kern-API** fungeert als een uniforme interface voor het beheren van kern CRM-entiteiten (personen, bedrijven, notities, taken) en hun relaties, met **zowel REST als GraphQL** interactiemodellen.
|
||
|
||
### Metadata API
|
||
|
||
Toegankelijk via `/rest/metadata/` of `/metadata/`.
|
||
De Metadata API-eindpunten stellen je in staat om informatie over je schema en instellingen op te halen. Bijvoorbeeld, je kunt definities van aangepaste velden, objectschema's, etc. ophalen.
|
||
|
||
- **Voorbeeld Eindpunten:**
|
||
|
||
- `GET /rest/metadata/objects` – Lijst alle objecttypes en hun metadata (velden, relaties).
|
||
- `GET /rest/metadata/objects/{objectName}` – Haal metadata op voor een specifiek object (bijv., `personen`, `bedrijven`).
|
||
- `GET /rest/metadata/picklists` – Haal picklist (dropdown) veldopties op, gedefinieerd in de CRM.
|
||
|
||
Typisch worden de metadata-eindpunten gebruikt om de structuur van gegevens te begrijpen (voor dynamische integraties of formulierbouw) in plaats van om daadwerkelijke records te beheren. Ze zijn in de meeste gevallen alleen-lezen. Authenticatie is ook vereist voor deze (gebruik je API-sleutel). |