ReadyZap API: criar chave e primeiro uso

A Readyzap API deixa o seu sistema consultar a sua conta, os seus chips e as suas campanhas. Ela está disponível nos planos Pro e Business ativos.

Criar a chave

1. No menu, abra Integrações e depois Readyzap API.
2. No passo Crie e guarde sua chave, clique em Criar ou gerenciar chave.

1. Em Nome da chave, dê um nome que lembre o uso, por exemplo Integração CRM, e clique em Criar chave.

1. A chave aparece uma única vez. Clique em Copiar e guarde em lugar seguro.

Na lista, a chave aparece só com o começo, para você reconhecer. Esse pedaço não serve para usar a API.

Fazer a primeira consulta

1. Em Escolha o que consultar, clique na consulta que quer, por exemplo Chips do Aquecedor.
2. Em Copie e execute um exemplo, escolha cURL, JavaScript ou Python e clique em Copiar.

1. A chave vai no cabeçalho Authorization, depois de Bearer e um espaço. Os exemplos leem a chave da variável READYZAP_API_KEY. Veja como preparar em Como preparar a chave no terminal.
2. Em Confira a resposta, compare com o exemplo. Uma consulta certa volta com os dados dentro de data.

Consultas de Conexões do Disparador e Campanhas exigem o Disparador liberado na sua conta.

Se der erro

• 401 chave errada, incompleta ou revogada.
• 403 plano sem acesso à API ou Disparador não liberado.
• 429 passou de 60 consultas por minuto. Aguarde e tente de novo.

Cuidados

• Até 5 chaves ativas por conta. Para criar outra, revogue uma.
• Nunca coloque a chave no código público do seu site nem envie para outras pessoas, nem para o suporte.
• Se a chave vazar, clique em Revogar. Tudo que usa essa chave para na hora.
• Para a maioria das contas, a API é somente leitura: não envia mensagens e não altera dados. No grupo de teste, a nova chave pode receber permissões extras, que você marca em Permissões da nova chave.

Para os detalhes técnicos de cada consulta, clique em Ver documentação, no alto da tela Readyzap API.

Os prints usam dados de exemplo: nomes e números são fictícios.