9bc5486d0d
Created by Github action --------- Co-authored-by: github-actions <github-actions@twenty.com>
84 lines
3.5 KiB
Plaintext
84 lines
3.5 KiB
Plaintext
---
|
|
title: API klíče & 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: Naučte se, jak připojit Twenty k vašim dalším nástrojům.
|
|
---
|
|
|
|
import { VimeoEmbed } from '/snippets/vimeo-embed.mdx';
|
|
|
|
<Frame>
|
|
<img src="/images/user-guide/api/api.png" alt="Header" />
|
|
</Frame>
|
|
|
|
## API Klíče
|
|
|
|
API klíče umožňují automatizovaný přístup k vašim CRM datům, synchronizaci dat s jinými systémy a vytváření vlastních integrací nebo řešení.
|
|
|
|
### Vytvořit API klíč
|
|
|
|
1. Go to **Settings → APIs & Webhooks**
|
|
2. Klikněte na **+ Vytvořit klíč** v pravém horním rohu
|
|
3. Nakonfigurujte svůj API klíč:
|
|
- **Název**: Dejte svému API klíči popisný název
|
|
- **Datum vypršení platnosti**: Nastavte, kdy by měl klíč vypršet
|
|
4. Klikněte na **Uložit** pro vygenerování vašeho API klíče
|
|
5. **Důležité**: Okamžitě zkopírujte a uložte svůj API klíč, zobrazuje se pouze jednou
|
|
|
|
Po vytvoření poskytuje API klíč přístup k vaší vlastní API dokumentaci a testovací platformě, kde můžete zkoušet koncové body s vaším skutečným datovým modelem.
|
|
|
|
<Warning>
|
|
Protože váš API klíč poskytuje přístup k citlivým informacím, neměli byste jej sdílet se službami, kterým plně nedůvěřujete. Pokud se dostane na veřejnost, někdo jej může zneužít. Pokud byla bezpečnost vašeho API klíče ohrožena, okamžitě jej deaktivujte a vygenerujte nový.
|
|
</Warning>
|
|
<VimeoEmbed videoId="928786722" title="Creating API key" />
|
|
|
|
### Spravovat API klíče
|
|
|
|
**Regenerovat API klíč:**
|
|
|
|
1. Go to **Settings → APIs & Webhooks**
|
|
2. Klikněte na API klíč, který chcete regenerovat
|
|
3. Klikněte na tlačítko **Regenerovat**
|
|
4. Zkopírujte a okamžitě uložte nový API klíč.
|
|
|
|
**Smazat API klíč:**
|
|
|
|
1. Najděte API klíč ve vašem seznamu.
|
|
2. Klikněte na klíč pro zobrazení jeho podrobností.
|
|
3. Klikněte na **Smazat**, abyste jej trvale odstranili.
|
|
|
|
## Webhooky
|
|
|
|
Webhooks umožňují okamžité aktualizace na zadanou URL o změnách nebo událostech spojených s vašimi zákaznickými daty.
|
|
|
|
Například, když se Příležitost přesune na „Uzavřená a vyhraná“, webhook může automaticky spustit vytvoření faktury ve vašem účetním systému. Všimněte si, že tento typ automatizace může být také dosažen pomocí funkce [Workflows](/l/cs/user-guide/workflows/getting-started-workflows) v aplikaci Twenty, která nabízí spouštěče založené na aktualizacích polí pro interní automatizaci.
|
|
|
|
Webhooks jsou ideální pro integraci s externími systémy, zatímco Workflows podporují jak interní automatizaci, tak i připojení k externím nástrojům prostřednictvím spouštěčů webhook, uzlů kódu a HTTP uzlů.
|
|
|
|
### Vytvořit Webhook
|
|
|
|
1. Přejděte na **Nastavení → API & Webhooks → Webhooks**
|
|
2. Klikněte na **+ Vytvořit webhook**
|
|
3. Zadejte URL svého webhooku (kam chcete přijímat oznámení)
|
|
4. Klikněte **Uložit**
|
|
|
|
Váš webhook začne okamžitě přijímat oznámení v reálném čase o změnách vašich CRM dat.
|
|
|
|
<VimeoEmbed videoId="928786708" title="Video demonstration" />
|
|
|
|
### Spravovat Webhooky
|
|
|
|
**Smazat tento webhook:**
|
|
|
|
1. Přejděte na **Nastavení → API & Webhooks → Webhooks**
|
|
2. Najděte webhook, který chcete odstranit.
|
|
3. Klikněte na webhook.
|
|
4. Klikněte na **Smazat** a potvrďte v popup okně.
|
|
|
|
**Upravit Webhook:**
|
|
|
|
1. Klikněte na webhook, který chcete změnit.
|
|
2. Aktualizujte URL nebo jiná nastavení.
|
|
3. Klikněte **Uložit** pro použití změn.
|
|
|