Developers
Criar chave de APIEntrar na plataforma

Primeiros passos

O que a API aberta da Astrify Flows faz, como conseguir uma chave e como fazer a primeira requisição em poucos minutos.

A API aberta é a API REST da Astrify Flows. Ela usa JSON (UTF-8) e dá acesso, pela sua integração, aos mesmos dados que a sua equipe vê na plataforma: CRM, Quadros, atendimento, Workflows e e-mail marketing.

O que dá para fazer

CRM

Criar, consultar, atualizar e mesclar leads e contatos; listar funis, etapas, origens e motivos de perda; produtos, propostas, etiquetas e campos personalizados.

Quadros e tarefas

Criar quadros, colunas e cards, mover cards, checklists, comentários, anexos e participantes. Tarefas são os cards do quadro “Tarefas”.

Atendimento e mensagens

Listar conversas e mensagens, enviar texto e mídia por WhatsApp, agendar mensagens e consultar mensagens rápidas e instâncias.

Workflows e e-mail

Disparar Workflows por evento, ver execuções, enviar e-mail transacional, criar listas de e-mail e inscrever contatos com consentimento.

A lista completa de rotas, com parâmetros e exemplos, está na Referência da API.

Como conseguir uma chave

  1. Entre na plataforma em app.astrify.com.br com um usuário administrador (ou com um cargo que tenha permissão na API aberta em Cargos e acesso).

  2. Abra Configurações → API aberta e clique em Nova chave.

  3. Dê um nome à chave (por exemplo, “Integração com o ERP”), escolha em Expira em a validade (30 dias, 90 dias, 180 dias, 1 ano ou 2 anos), marque as Permissões (escopos) de que a integração precisa e, se quiser, informe os IPs permitidos.

  4. Clique em Criar chave e copie a chave na tela Copie sua chave agora. Ela aparece uma única vez: depois disso a plataforma só mostra o prefixo. Se perder, revogue e crie outra.

Mais detalhes em Autenticação e chaves de API.

URL base

Todas as rotas da API aberta ficam em:

https://api2.astrify.com.br/v1/

Sua primeira requisição

Guarde a chave numa variável de ambiente (nunca no código do site ou do aplicativo) e chame GET /v1/me. Se a chave estiver valendo, a resposta traz a empresa, os escopos e a validade.

Terminal window
export ASTRIFY_API_KEY="SUA_CHAVE_DE_API"
curl https://api2.astrify.com.br/v1/me \
-H "Authorization: Bearer $ASTRIFY_API_KEY"

Resposta (exemplo):

{
"data": {
"empresa_id": "00000000-0000-0000-0000-000000000000",
"chave": {
"id": "11111111-1111-1111-1111-111111111111",
"nome": "Integração com o ERP",
"escopos": ["contatos:write", "leads:write"],
"expira_em": "2027-11-15T12:00:00+00:00",
"limite_rpm": 120
}
}
}

Agora crie um contato (escopo contatos:write):

Terminal window
curl -X POST https://api2.astrify.com.br/v1/contatos \
-H "Authorization: Bearer $ASTRIFY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"nome":"Ana Souza","whatsapp":"5511900000000","email":"ana@exemplo.com"}'

Próximos passos

Digite para pesquisar em toda a documentação.