Created by Github action --------- Co-authored-by: github-actions <github-actions@twenty.com>
84 lines
3.3 KiB
Plaintext
84 lines
3.3 KiB
Plaintext
---
|
|
title: API-sleutels & Webhooks
|
|
info: "Skep en bestuur API-sleutels vir verifikasie en stel webhooks op vir intydse kennisgewings."
|
|
image: /images/user-guide/api/api.png
|
|
sectionInfo: Leer hoe om Twenty aan jou ander gereedskap te koppel.
|
|
---
|
|
|
|
import { VimeoEmbed } from '/snippets/vimeo-embed.mdx';
|
|
|
|
<Frame>
|
|
<img src="/images/user-guide/api/api.png" alt="Header" />
|
|
</Frame>
|
|
|
|
## API Sleutels
|
|
|
|
API-sleutels laat outomatiese toegang tot jou CRM-data toe, sinchroniseer data met ander stelsels, en skep persoonlike integrasies of oplossings.
|
|
|
|
### Skep 'n API Sleutel
|
|
|
|
1. Gaan na **Instellings → API's & Webhooks**
|
|
2. Klik **+ Skep sleutel** regs bo
|
|
3. Stel jou API-sleutel in:
|
|
- **Naam**: Gee jou API-sleutel 'n beskrywende naam
|
|
- **Vervaldatum**: Stel wanneer die sleutel moet verval
|
|
4. Klik **Stoor** om jou API-sleutel te genereer
|
|
5. **Belangrik**: Kopieer en stoor jou API-sleutel onmiddellik, dit word net een keer getoon
|
|
|
|
Sodra geskep, bied jou API-sleutel toegang tot jou persoonlike API-dokumentasie en speelgrond waar jy eindpunte met jou werklike datamodel kan toets.
|
|
|
|
<Warning>
|
|
Aangesien jou API-sleutel toegang tot sensitiewe inligting gee, moet jy dit nie met dienste deel wat jy nie ten volle vertrou nie. Indien dit uitlek, kan iemand dit kwaadwillig gebruik. As die sekuriteit van jou API-sleutel gekompromitteer is, deaktiveer dit dadelik en genereer 'n nuwe een.
|
|
</Warning>
|
|
<VimeoEmbed videoId="928786722" title="Creating API key" />
|
|
|
|
### Bestuur API Sleutels
|
|
|
|
**Genereer 'n API Sleutel Opnuut:**
|
|
|
|
1. Gaan na **Instellings → API's & Webhooks**
|
|
2. Klik op die API-sleutel wat jy wil hergenereer
|
|
3. Klik die **Genereer opnuut** knoppie
|
|
4. Kopieer en stoor die nuwe API-sleutel onmiddellik
|
|
|
|
**Verwyder API-sleutel:**
|
|
|
|
1. Vind die API-sleutel in jou lys
|
|
2. Klik op die sleutel om die besonderhede oop te maak
|
|
3. Klik **Verwyder** om dit permanent te verwyder
|
|
|
|
## Webhake
|
|
|
|
Webhooks maak voorsiening vir onmiddellike opdaterings aan jou gespesifiseerde URL oor veranderinge of gebeure wat verband hou met jou kliëntdata.
|
|
|
|
Byvoorbeeld, wanneer 'n Geleentheid na "Gesluit Gewen" beweeg, kan 'n webhook outomaties faktuur skepping in jou rekeningstelsel lanceer. Notering dat hierdie tipe outomatisering ook bereik kan word deur Twenty se in-app [Workflows-funksie](/l/af/user-guide/workflows/getting-started-workflows), wat skakelaars bied gebaseer op veldopdaterings vir interne outomatisering.
|
|
|
|
Webhooks is ideaal vir integrasie met eksterne stelsels, terwyl Workflows beide interne outomatisering en eksterne instrumentverbinding via webhook-lansers, kodenodes en HTTP-nodes ondersteun.
|
|
|
|
### Skep 'n Webhook
|
|
|
|
1. Gaan na **Instellings → API's & Webhooks → Webhooks**
|
|
2. Klik **+ Skep webhook**
|
|
3. Voer jou webhook URL in (waar jy kennisgewings wil ontvang)
|
|
4. Klik **Stoor**
|
|
|
|
Jou webhook sal onmiddellik begin om intydse kennisgewings oor veranderinge aan jou CRM-data te ontvang.
|
|
|
|
<VimeoEmbed videoId="928786708" title="Video demonstration" />
|
|
|
|
### Bestuur Webhooks
|
|
|
|
**Verwyder 'n Webhook:**
|
|
|
|
1. Gaan na **Instellings → API's & Webhooks → Webhooks**
|
|
2. Vind die webhook wat jy wil verwyder
|
|
3. Klik op die webhook
|
|
4. Klik **Verwyder** en bevestig in die popup
|
|
|
|
**Redigeer 'n Webhook:**
|
|
|
|
1. Klik op die webhook wat jy wil verander
|
|
2. Werk die URL of ander instellings op
|
|
3. Klik **Stoor** om veranderinge toe te pas
|
|
|