9bc5486d0d
Created by Github action --------- Co-authored-by: github-actions <github-actions@twenty.com>
84 lines
4.8 KiB
Plaintext
84 lines
4.8 KiB
Plaintext
---
|
|
title: API ключи и вебхуки
|
|
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, синхронизировать данные с другими системами и создавать индивидуальные интеграции или решения.
|
|
|
|
### Create an API Key
|
|
|
|
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. Click on the key to open its details
|
|
3. Click **Delete** to remove it permanently
|
|
|
|
## Вебхуки
|
|
|
|
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. Note that this type of automation can also be achieved using Twenty's in-app [Workflows feature](/l/ru/user-guide/workflows/getting-started-workflows), which offers triggers based on field updates for internal automation.
|
|
|
|
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.
|
|
|
|
### Создать Webhook
|
|
|
|
1. Перейдите в **Настройки → API и Вебхуки → Вебхуки**
|
|
2. Нажмите **+ Создать вебхук**
|
|
3. Введите ваш вебхук URL (куда вы хотите получать уведомления).
|
|
4. Нажмите **Сохранить**
|
|
|
|
Your webhook will immediately start receiving real-time notifications about changes to your CRM data.
|
|
|
|
<VimeoEmbed videoId="928786708" title="Video demonstration" />
|
|
|
|
### Manage Webhooks
|
|
|
|
**Удалить вебхук:**
|
|
|
|
1. Перейдите в **Настройки → API и Вебхуки → Вебхуки**
|
|
2. Найдите вебхук, который вы хотите удалить.
|
|
3. Нажмите на вебхук.
|
|
4. Click **Delete** and confirm in the popup
|
|
|
|
**Редактировать вебхук:**
|
|
|
|
1. Нажмите на вебхук, который вы хотите изменить.
|
|
2. Обновите URL или другие настройки.
|
|
3. Нажмите **Сохранить** для применения изменений.
|
|
|