Como podemos ajudar?

02. Como acessar o Zenvia APIs
4 min
Criado por LS em 24/01/2023 14:45
Atualizado por Ligia Sarmento em 05/01/2024 11:27

Antes de usar qualquer API da Zenvia, é necessário seguir alguns caminhos. 

Neste artigo, você verá as etapas necessárias, como Criar uma conta e Criar um Token. Além disso, verá também como Registrar um Webhook, caso queira realizar o registro de um. 

  1. Criar Token
  2. Registrar Webhook

Criar uma conta

Para se cadastrar na nossa plataforma, siga o percurso abaixo.

1. Acesse a Plataforma Zenvia e crie sua conta preenchendo os campos solicitados, conforme imagem abaixo abaixo:

criarconta.JPG

2. Configure os canais desejados para enviar ou receber mensagens. 
3. Clique em Produtos na barra superior e, em seguida, role até a opção Integrações.

COMO ACESSAR.jpg

4. Clique em Conectar na tela que foi exibida com todos os canais. Esta opção aparecerá naqueles canais que ainda não possuem nenhuma integração. 
5. Realize as etapas exigidas para conectar sua conta ao canal desejado. 

03.gif

Criar um token de API

O Token é uma chave de autenticação com a API Zenvia. É com ela que você conseguirá realizar as integrações e demais chamadas com as APIs. 

Para criar, siga as etapas abaixo.

1. Clique em Desenvolvedores na página inicial da plataforma.

2. Clique em Tokens e Webhooks.

04.png

 

Na tela, as informações exibidas são:

  • Nome do Token;
  • X-API-Token: chave do Token;
  • Tipo de autenticação: pode ser Padrão ou Com assinatura.
  • Criado em: data e horário que o Token foi criado.
  • Copiar Token: caso deseje copiar a chave, basta clicar nesta opção;
  • Excluir: caso deseje deletar um Token, basta clicar nesta opção;

    novatelatoken.png

3. Clique em Criar novo;
4. Identifique-o em Nome do Token;
5. Escolha entre Padrão ou Com assinatura em Tipo de autenticação;
6. Clique em Salvar e
o seu Token já estará disponível para uso. Para utilizá-lo, basta clicar na opção Copiar token exibida na tela de informações mostrada acima.
novatelatoken2.gif

⚠️Atenção: armazene com segurança o seu código. Acesse a nossa documentação técnica para desenvolvedores e veja mais detalhes sobre este recurso.

Registrar um webhook

O Webhook permite que você receba eventos na URL configurada para receber as informações desejadas.
 

Para registrar, siga as etapas abaixo.

  1. Clique em Desenvolvedores na barra superior da página inicial da plataforma;
  2. Clique Tokens e Webhooks;

    04.png
  3. Escolha a seção de Webhooks;
  4. Clique em Criar novo.
    Web01.jpg
  5. Selecione o Status, Versão, Tipo de evento e Canal;
  6. Insira a URL que deseja receber os eventos e informações desejadas;
  7. Clique em Salvar e o seu Webhook já estará configurado para receber eventos da nossa API. 
 novatelawebhook2.gif

💡 Dica: Acesse a nossa documentação técnica para desenvolvedores e veja mais detalhes sobre este recurso.
Este artigo resolveu sua dúvida?
Últimos artigos visitados