9bc5486d0d
Created by Github action --------- Co-authored-by: github-actions <github-actions@twenty.com>
84 lines
5.6 KiB
Plaintext
84 lines
5.6 KiB
Plaintext
---
|
||
title: API Ключі та Webhooks
|
||
info: "Створюйте та керуйте ключами API для автентифікації та налаштовуйте вебхуки для сповіщень у реальному часі."
|
||
image: /images/user-guide/api/api.png
|
||
sectionInfo: Дізнайтеся, як підключити Twenty до ваших інших інструментів.
|
||
---
|
||
|
||
import { VimeoEmbed } from '/snippets/vimeo-embed.mdx';
|
||
|
||
<Frame>
|
||
<img src="/images/user-guide/api/api.png" alt="Header" />
|
||
</Frame>
|
||
|
||
## Ключі API
|
||
|
||
Ключі API дозволяють автоматизований доступ до ваших даних CRM, синхронізувати дані з іншими системами і створювати власні інтеграції чи рішення.
|
||
|
||
### Створити ключ API
|
||
|
||
1. Перейдіть у **Налаштування → API та вебхуки**
|
||
2. Натисніть **+ Створити ключ** у верхньому правому куті
|
||
3. Налаштуйте свій API ключ:
|
||
- **Ім'я**: Дайте вашому ключу API описову назву
|
||
- **Дата закінчення терміну дії**: Встановіть, коли ключ повинен закінчитися
|
||
4. Натисніть **Зберегти**, щоб згенерувати ваш ключ API
|
||
5. **Важливо**: Скопіюйте та збережіть ваш ключ API негайно, він буде показаний лише один раз
|
||
|
||
Після створення ваш ключ API надає доступ до вашої спеціальної API-документації та ігрового майданчика, де ви можете тестувати кінцеві точки з вашою фактичною моделлю даних.
|
||
|
||
<Warning>
|
||
Оскільки ваш ключ API надає доступ до конфіденційної інформації, його не варто ділити з сервісами, яким ви повністю не довіряєте. Якщо він витече, хтось може використати його зі злочинними намірами. Якщо безпека вашого ключа API була скомпрометована, негайно вимкніть його і створіть новий.
|
||
</Warning>
|
||
<VimeoEmbed videoId="928786722" title="Creating API key" />
|
||
|
||
### Керуйте ключами API
|
||
|
||
**Перегенеруйте ключ API:**
|
||
|
||
1. Перейдіть у **Налаштування → API та вебхуки**
|
||
2. Натисніть на ключ API, який ви хочете перегенерувати
|
||
3. Натисніть кнопку **Відновити**
|
||
4. Копіюйте та зберігайте новий ключ API негайно
|
||
|
||
**Видалити ключ API:**
|
||
|
||
1. Знайдіть ключ API у вашому списку
|
||
2. Натисніть на ключ, щоб відкрити його деталі
|
||
3. Натисніть **Видалити**, щоб видалити його назавжди
|
||
|
||
## Вебхуки
|
||
|
||
Webhooks дозволяють отримувати миттєві оновлення на вашу вказану URL про зміни чи події, пов’язані з даними вашого клієнта.
|
||
|
||
Наприклад, коли Оппортуніті переходить до "Закриті виграні", вебхук може автоматично запустити створення рахунку в вашій бухгалтерській системі. Зверніть увагу, що цей тип автоматизації також можна реалізувати за допомогою [функції Workflows у додатку Twenty](/l/uk/user-guide/workflows/getting-started-workflows), яка пропонує тригери на основі оновлень полів для внутрішньої автоматизації.
|
||
|
||
Webhooks ідеально підходять для інтеграції із зовнішніми системами, тоді як Workflows підтримують як внутрішню автоматизацію, так і з'єднання зовнішніх інструментів через тригери вебхуків, вузли коду та HTTP вузли.
|
||
|
||
### Створити Webhook
|
||
|
||
1. Перейдіть до **Налаштування → API та Webhooks → Webhooks**
|
||
2. Клацніть **+ Створити вебхук**
|
||
3. Введіть свій URL вебхука (куди ви хочете отримувати сповіщення)
|
||
4. Натисніть **Зберегти**
|
||
|
||
Ваш вебхук негайно почне отримувати сповіщення в режимі реального часу про зміни у ваших даних CRM.
|
||
|
||
<VimeoEmbed videoId="928786708" title="Video demonstration" />
|
||
|
||
### Керування Webhooks
|
||
|
||
**Видалити вебхук:**
|
||
|
||
1. Перейдіть до **Налаштування → API та Webhooks → Webhooks**
|
||
2. Знайдіть вебхук, який ви хочете видалити
|
||
3. Клацніть на вебхук
|
||
4. Натисніть **Видалити** та підтвердіть у спливаючому вікні
|
||
|
||
**Редагувати вебхук:**
|
||
|
||
1. Клацніть на вебхук, який ви хочете змінити
|
||
2. Оновіть URL або інші налаштування
|
||
3. Натисніть **Зберегти**, щоб застосувати зміни
|
||
|