Developers
Criar chave de APIEntrar na plataforma

Referência da API

Todas as rotas da API aberta da Astrify Flows, com a especificação OpenAPI 3.1 e a coleção do Postman para baixar.

A referência é gerada a partir da especificação OpenAPI 3.1.0 da API aberta (versão 1.0), com 128 operações em 17 áreas. Cada rota mostra o escopo exigido, os parâmetros, o corpo e exemplos em várias linguagens.

Abrir a referência interativa

Downloads

Especificação OpenAPI

Importe no Insomnia, no Swagger UI ou num gerador de cliente.

Baixar openapi.json

Coleção do Postman

Defina as variáveis api_key (a sua chave) e base_url (https://api2.astrify.com.br) na coleção.

Baixar a coleção

A especificação atualizada também é servida pela própria API, sem chave, em https://api2.astrify.com.br/v1/openapi.json.

Rotas por área

Cada área tem uma página com todas as rotas: método e caminho, escopo, parâmetros, campos do corpo, exemplos em curl, Node.js e Python, a resposta e os erros. São 128 rotas no total.

ÁreaRotasO que cobre
Chave de API1Confira se a chave vale, de qual empresa ela é e quais escopos ela tem.
Campanhas de WhatsApp3Liste, pause e retome as campanhas de WhatsApp.
Contatos8Crie, consulte, atualize, mescle e exclua contatos, e encontre duplicados.
Conversas3Leia as conversas do atendimento e as mensagens de cada uma.
E-mail6Envie e-mail transacional, crie listas, inscreva contatos com consentimento e leia as campanhas de e-mail.
Equipes6Crie e edite equipes e adicione ou remova usuários.
Etiquetas4Liste, crie, renomeie e exclua etiquetas.
Funis5Leia os funis, as etapas, as origens de lead e os motivos de perda da empresa.
Leads22Crie, consulte, atualize, mescle e importe leads, com atividades, observações, participantes, produtos e campos personalizados.
Mensagens7Envie texto e mídia pelo WhatsApp, agende mensagens e leia as mensagens rápidas e as instâncias.
Notificações2Leia e marque como lidas as notificações do usuário dono da chave.
Produtos4Mantenha o catálogo de produtos usado nos leads e nas propostas.
Propostas7Crie, envie, cancele, duplique e baixe em PDF as propostas dos leads.
Quadros41Quadros, colunas e cards, com checklists, comentários, anexos, etiquetas, membros e campos personalizados.
Relatórios2Os números do e-mail marketing por período e por campanha.
Tarefas4As tarefas da empresa (os cards do quadro “Tarefas”).
Workflows3Liste os Workflows, veja as execuções e dispare eventos para eles.

Para testar uma rota antes de escrever código, veja Testar e validar chamadas.

Autenticação na referência

Todas as rotas usam o esquema bearerAuth: Authorization: Bearer SUA_CHAVE_DE_API. A especificação também lista, em cada rota, os cabeçalhos authorization e x-session-token como parâmetros: o x-session-token é o login da plataforma e não vale na API aberta. Use sempre a chave. Veja Autenticação e chaves de API.

Digite para pesquisar em toda a documentação.