Criar leads no CRM a partir do site, do ERP ou de uma automação
POST /api/crm/integrations/leads
Chave de API no header Authorization
Enviar um formulário do CRM pelo seu próprio front
POST /api/crm/forms/<token>/submit
Token público do formulário publicado
Iniciar um workflow do CRM a partir de um evento seu
POST /api/crm/workflows/<token>/trigger
Token do gatilho, na URL
Abrir (e encerrar) chamados no ServiceDesk a partir do seu sistema
POST /api/servicedesk/monitoring/<token>
Token da origem, na URL
Refletir issues e pull/merge requests nos chamados
POST /api/integrations/github/webhook e POST /api/integrations/gitlab/webhook
Assinatura do GitHub ou secret token do GitLab
O restante da API (as rotas em /api/workspaces/<id>/...) é a que o próprio
aplicativo usa, exige a sessão de um usuário e pode mudar a cada versão. Para
automatizar, use a API v1. Veja Autenticação e chaves.
Entre. O terminal mostra um código e abre /device no navegador; confira o
código, escolha o workspace, os módulos e o nível de acesso e clique em
Permitir acesso:
steel login
Confira quem está conectado e faça a primeira chamada:
steel whoami
steel api GET /me
steel sd ticket list --assignee me
201: lead novo, já pontuado pelas regras de score e com dono pelas
regras de roteamento.
200: já existia um lead em aberto com o mesmo e-mail ou telefone. A
API devolve esse lead e não cria outro, então reenviar a mesma requisição é
seguro.
Se algo der errado, success vem false com um código estável em
error.code. Os mais comuns aqui:
Status
Código
Causa
401
UNAUTHORIZED
Header Authorization ausente ou sem Bearer
401
CRM_INTEGRATION_KEY_INVALID
Chave errada ou revogada
403
MODULE_DISABLED
O CRM foi desabilitado no workspace da chave
422
VALIDATION_ERROR
Corpo inválido: sem name, sem e-mail nem telefone, e-mail malformado
429
RATE_LIMITED
Mais de 100 requisições por minuto com a mesma chave
