9bc5486d0d
Created by Github action --------- Co-authored-by: github-actions <github-actions@twenty.com>
84 lines
3.2 KiB
Plaintext
84 lines
3.2 KiB
Plaintext
---
|
|
title: API-avaimet & Webhooks
|
|
info: "Create and manage API keys for authentication and set up webhooks for real-time notifications."
|
|
image: /images/user-guide/api/api.png
|
|
sectionInfo: Opi yhdistämään Twenty muihin työkaluihisi.
|
|
---
|
|
|
|
import { VimeoEmbed } from '/snippets/vimeo-embed.mdx';
|
|
|
|
<Frame>
|
|
<img src="/images/user-guide/api/api.png" alt="Header" />
|
|
</Frame>
|
|
|
|
## API-avaimet
|
|
|
|
API keys allow automated access to your CRM data, synchronize data with other systems, and create custom integrations or solutions.
|
|
|
|
### Luo API-avain
|
|
|
|
1. Go to **Settings → APIs & Webhooks**
|
|
2. Napsauta **+ Luo avain** oikeasta yläkulmasta
|
|
3. Määritä API-avaimesi:
|
|
- **Nimi**: Anna API-avaimelle kuvaileva nimi
|
|
- **Vanhentumispäivämäärä**: Määritä, milloin avaimen tulisi vanhentua
|
|
4. Napsauta **Tallenna** luodaksesi API-avaimesi
|
|
5. **Tärkeää**: Kopioi ja tallenna API-avaimesi välittömästi, se näkyy vain kerran
|
|
|
|
Once created, your API key provides access to your custom API documentation and playground where you can test endpoints with your actual data model.
|
|
|
|
<Warning>
|
|
Koska API-avaimesi antaa pääsyn arkaluonteisiin tietoihin, sitä ei pitäisi jakaa palveluiden kanssa, joihin et täysin luota. Jos avain vuotaa, joku voi käyttää sitä pahantahtoisesti. Jos API-avaimesi turvallisuus vaarantuu, poista se välittömästi käytöstä ja luo uusi.
|
|
</Warning>
|
|
<VimeoEmbed videoId="928786722" title="Creating API key" />
|
|
|
|
### Hallitse API-avaimia
|
|
|
|
**Luo uudelleen API-avain:**
|
|
|
|
1. Go to **Settings → APIs & Webhooks**
|
|
2. Napsauta API-avainta, jonka haluat luoda uudelleen
|
|
3. Valitse **Luo uudelleen** -painike
|
|
4. Kopioi ja tallenna uusi API-avain välittömästi.
|
|
|
|
**Poista API-avain:**
|
|
|
|
1. Etsi API-avain luettelostasi.
|
|
2. Napsauta avainta avataksesi sen tiedot.
|
|
3. Click **Delete** to remove it permanently
|
|
|
|
## Webhookit
|
|
|
|
Webhooks allow for immediate updates to your specified URL about changes or events related to your customer data.
|
|
|
|
For example, when an Opportunity moves to "Closed Won", a webhook can automatically trigger invoice creation in your accounting system. Huomaa, että tämän tyyppinen automaatio voidaan saavuttaa myös Twentyn sovelluksen sisäisen [Workflows -ominaisuuden](/l/fi/user-guide/workflows/getting-started-workflows) avulla, joka tarjoaa laukaisimia kenttäpäivitysten perusteella sisäistä automaatiota varten.
|
|
|
|
Webhooks are ideal for integrating with external systems, while Workflows support both internal automation and external tool connections via webhook triggers, code nodes, and HTTP nodes.
|
|
|
|
### Luo Webhook
|
|
|
|
1. Siirry kohtaan **Asetukset → API:t & Webhookit → Webhookit**
|
|
2. Klikkaa **+ Luo webhook**
|
|
3. Syötä webhook-URL-osoitteesi (paikka, johon haluat vastaanottaa ilmoituksia)
|
|
4. Klikkaa **Tallenna**
|
|
|
|
Webhook alkaa heti vastaanottaa reaaliaikaisia ilmoituksia CRM-tietojesi muutoksista.
|
|
|
|
<VimeoEmbed videoId="928786708" title="Video demonstration" />
|
|
|
|
### Manage Webhooks
|
|
|
|
**Poista Webhook:**
|
|
|
|
1. Siirry kohtaan **Asetukset → API:t & Webhookit → Webhookit**
|
|
2. Etsi webhook, jonka haluat poistaa
|
|
3. Napsauta webhookia
|
|
4. Click **Delete** and confirm in the popup
|
|
|
|
**Edit a Webhook:**
|
|
|
|
1. Click on the webhook you want to modify
|
|
2. Päivitä URL tai muut asetukset
|
|
3. Click **Save** to apply changes
|
|
|