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 e Webhooks
|
|
info: "Crie e gerencie chaves de API para autenticação e configure webhooks para notificações em tempo real."
|
|
image: /images/user-guide/api/api.png
|
|
sectionInfo: Aprenda como conectar o Twenty às suas outras ferramentas.
|
|
---
|
|
|
|
import { VimeoEmbed } from '/snippets/vimeo-embed.mdx';
|
|
|
|
<Frame>
|
|
<img src="/images/user-guide/api/api.png" alt="Header" />
|
|
</Frame>
|
|
|
|
## Chaves API
|
|
|
|
As chaves de API permitem acesso automatizado aos dados do seu CRM, sincronizam dados com outros sistemas e criam integrações ou soluções personalizadas.
|
|
|
|
### Criar uma Chave de API.
|
|
|
|
1. Vá para **Configurações → APIs & Webhooks**
|
|
2. Clique em **+ Criar chave** no canto superior direito
|
|
3. Configure sua chave de API:
|
|
- **Nome**: Dê um nome descritivo à sua chave de API
|
|
- **Data de Expiração**: Defina quando a chave deve expirar
|
|
4. Clique em **Salvar** para gerar sua chave de API
|
|
5. **Importante**: Copie e armazene sua chave de API imediatamente, ela é mostrada apenas uma vez
|
|
|
|
Uma vez criada, sua chave de API fornece acesso à sua documentação de API personalizada e a um playground onde você pode testar endpoints com seu modelo de dados real.
|
|
|
|
<Warning>
|
|
Como sua chave de API oferece acesso a informações sensíveis, você não deve compartilhá-la com serviços nos quais não confia totalmente. Se vazada, alguém pode usá-la maliciosamente. Se a segurança da sua chave de API for comprometida, desabilite-a imediatamente e gere uma nova.
|
|
</Warning>
|
|
<VimeoEmbed videoId="928786722" title="Creating API key" />
|
|
|
|
### Gerenciar Chaves de API
|
|
|
|
**Regenerar uma Chave de API:**
|
|
|
|
1. Vá para **Configurações → APIs & Webhooks**
|
|
2. Clique na chave de API que você deseja regenerar
|
|
3. Clique no botão **Regenerar**
|
|
4. Copie e armazene a nova chave da API imediatamente
|
|
|
|
**Excluir Chave API:**
|
|
|
|
1. Encontre a chave da API na sua lista
|
|
2. Clique na chave para abrir seus detalhes
|
|
3. Clique em **Excluir** para remover permanentemente
|
|
|
|
## Webhooks
|
|
|
|
Webhooks permitem atualizações imediatas para o seu URL especificado sobre alterações ou eventos relacionados aos dados de seus clientes.
|
|
|
|
Por exemplo, quando uma Oportunidade se move para "Fechada Ganha", um webhook pode automaticamente acionar a criação de fatura em seu sistema de contabilidade. Observe que esse tipo de automação também pode ser alcançado usando o recurso [Workflows de Twenty](/l/pt/user-guide/workflows/getting-started-workflows) que oferece gatilhos baseados em atualizações de campo para automação interna.
|
|
|
|
Os Webhooks são ideais para integração com sistemas externos, enquanto os Workflows suportam automação interna e conexões de ferramentas externas por meio de gatilhos de webhook, nós de código e nós HTTP.
|
|
|
|
### Criar Webhook
|
|
|
|
1. Vá para **Configurações → APIs & Webhooks → Webhooks**
|
|
2. Clique em **+ Criar webhook**
|
|
3. Insira o URL do seu webhook (onde você deseja receber notificações)
|
|
4. Clique em **Salvar**
|
|
|
|
Seu webhook começará imediatamente a receber notificações em tempo real sobre alterações nos dados do seu CRM.
|
|
|
|
<VimeoEmbed videoId="928786708" title="Video demonstration" />
|
|
|
|
### Gerenciar Webhooks
|
|
|
|
**Excluir Webhook:**
|
|
|
|
1. Vá para **Configurações → APIs & Webhooks → Webhooks**
|
|
2. Encontre o webhook que você deseja remover
|
|
3. Clique no webhook
|
|
4. Clique em **Excluir** e confirme no popup
|
|
|
|
**Editar um Webhook:**
|
|
|
|
1. Clique no webhook que você deseja modificar
|
|
2. Atualize o URL ou outras configurações
|
|
3. Clique em **Salvar** para aplicar alterações
|
|
|