Como usar a API da SendPulse em fluxos
O criador de chatbots da SendPulse inclui o elemento Solicitação de API, que ajuda a enviar e receber dados de sistemas externos e internos. Isso amplia suas opções além dos cenários padrão, incluindo a criação de novos objetos ou o envio de mensagens através da API.
Neste artigo, falaremos sobre como autorizar e enviar solicitações para a SendPulse através da API.
Como autorizar solicitações
Autorize suas solicitações para confirmar sua identidade e permitir que seu chatbot acesse as funcionalidades da SendPulse através da API.
Copie suas credenciais da conta da SendPulse
Acesse Configurações > API. Copie seu ID e Senha, que serão usados para obter um token e criar variáveis de chatbot.
Como criar variáveis de chatbot
Crie variáveis globais no seu chatbot para salvar seus dados de autorização.
Para adicionar uma variável global, acesse seu chatbot > Configurações > Variáveis do bot, e clique em Criar variável.
Adicione as seguintes variáveis para poder obter um token:
$access_token |
String (texto) | Armazena o token de acesso atual retornado pela API da SendPulse após a autorização. Use-o no cabeçalho Autorização de suas solicitações.
No campo Value, insira |
$access_token_expiration |
DateTime | Armazena a data e a hora em que o token atual se torna inválido.
No campo Value, insira |
$SP_API_ID |
String (texto) | Usado para obter um token.
No campo Valor, insira o |
$SP_API_SECRET |
String (texto) | Usado com client_id para autorização.
No campo Value, insira o |
Obtenha um token de acesso
Cada solicitação para a API da SendPulse requer um token de acesso ou tecla. Você pode obter este token através do elemento Solicitação de API no fluxo do seu chatbot.
Arraste o elemento de Solicitação da API para o espaço de trabalho e selecione o tipo de solicitação POST para enviá-lo para https://api.sendpulse.com/oauth/access_token:
No campo Corpo da solicitação, insira o JSON:
{
"grant_type":"client_credentials",
"client_id":"{{$SP_API_ID}}",
"client_secret":"{{$SP_API_SECRET}}"
}Saiba mais sobre a autorização do Serviço de API REST da SendPulse.
Clique em Solicitação de teste. Se sua solicitação for bem-sucedida, você receberá uma resposta com os dados que você deve salvar.
Os tokens são válidos por 1 hora e não exigem uma nova solicitação para cada execução de fluxo.
Salve o token nas variáveis do seu chatbot
Use o elemento Ação: Definir variável para salvar seu token. Selecione a variável global $access_token e adicione o valor {{$['access_token']}} do elemento anterior como JSONPath.
Siga os mesmos passos para a variável global $access_token_expiration. Como seu token é válido por 1 hora, você pode usar esta variável antes de cada solicitação para decidir se precisa de um novo token ou se pode usar o existente. Atualize o valor conforme necessário.
Em Definir valor da variável, marque a caixa de seleção Inserir variável e selecione Data de execução. Em seguida, selecione a caixa de seleção Adicionar desvio de valor e defina + 59 minutos.
Utilize a API da SendPulse
Assim que você receber e salvar o token no seu chatbot, poderá usá-lo para fazer solicitações à API da SendPulse. Cada nova solicitação de API deve incluir um cabeçalho Authorization com seu token.
Você pode encontrar todos os métodos de solicitação disponíveis no serviço de API REST da SendPulse.
Adicione o elemento Solicitação de API à área de trabalho e configure-o.
| Método | Escolha um método com base no seu objetivo. Por exemplo, use POST para enviar uma mensagem para o Telegram e obter informações. Em seguida, adicione o URL do seu método. |
| Cabeçalho | Adicione Autorização com o valor {{$access_token}} do portador.
O token será recuperado automaticamente da variável. |
No início do seu fluxo, adicione o elemento Filtro: Valor da variável para confirmar que seu token não está vazio e ainda é válido. Nas configurações, selecione as duas variáveis globais e defina as seguintes condições:
$access_token |
Selecione a condição not empty (não vazia). |
$access_token_expiration |
Selecione a condição antes, marque a caixa de seleção Inserir variáveis e defina a variável Data de execução. |
Como exemplo, vamos ver como enviar uma mensagem para outro contato através do Telegram. No elemento Solicitação de API, selecione o método POST e cole este URL: https://api.sendpulse.com/telegram/contacts/send.
Clique em Adicionar cabeçalho, depois digite Autorização no primeiro campo e Portador {{$access_token}} no próximo.
Adicione o corpo da solicitação com os parâmetros necessários. Veja como ficará:
{
"contact_id": "string",
"message": {
"type": "photo",
"photo": "https://www.cdn.com/photo.png",
"caption": "string"
}
}
Você também pode escolher um template pronto em Chatbots > Templates > API.
Última Atualização: 05.09.2025
ou