Como integrar utilizando a API?

Aprenda a utilizar a nossa API para realizar integrações.

 

Como uso a API?

Dentro do Notificações Inteligentes

Para criar a integração, acesse a sua conta do Notificações Inteligentes e clique em Lojas:

4-Sep-16-2022-12-17-03-85-PM

Na página, clique em Criar loja:

5-Sep-16-2022-12-17-10-41-PM

Em seguida, na opção Descrição, é possível dar um apelido para a integração criada:



Na Plataforma, selecione a opção com o nome da integração, na categoria Outros, como demonstrado na imagem abaixo.



Dentro da API

Onde encontro os dados de configuração da API no Notificações Inteligentes?

Acesse a página inicial do Notificações Inteligentes. Em seguida, clique em Gerenciar Loja na integração com a API, como a imagem abaixo:



Dentro da integração com a API, procure por Como utilizar a nossa API, depois será possível encontrar o Endpoint copiá-lo e saberá como encontrar sua Token de Autenticação. Confira:



Agora, é só fazer o uso de acordo com as suas necessidades.

Leia nossa API Técnica

Como se trata de uma integração técnica, é interessante que você contrate um desenvolvedor para fazer a integração.


A nossa documentação técnica está disponível aqui, consulte ela para entender como disparar as notificações através da API.

Caso tenha alguma dúvida sobre a documentação, você pode entrar em contato com o suporte@notificacoesinteligentes.com

Consigo ter acesso a algum ambiente de testes?

Caso você seja algum desenvolvedor e queira desenvolver um módulo utilizando a nossa API, você pode criar uma conta no Notificações Inteligentes e, em seguida, criar uma loja e utilizar a nossa documentação técnica para integrar normalmente. Você não irá conseguir apenas enviar as mensagens, se não houver uma instância contratada.

Saiba mais sobre como usar a API aqui.


Como sei que deu certo?

Quer conferir se a integração do Notificações Inteligentes foi feita de maneira certa? Então, veja como você pode fazer a confirmação, seguindo estas etapas:

Verifique o checklist dentro da sua loja

Temos um checklist que te ajuda a entender se todas as configurações necessárias para o envio das notificações foram feitas.

Você consegue ter um exemplo do checklist logo abaixo:



Se todas as opções estiverem na cor verde, quer dizer que você fez todos os passos. Então, provavelmente, as notificações já devem estar sendo enviadas.

Recomendamos que não sejam feitos testes com dados falsos exemplo, utilizar o telefone assim; 31 9 9999-9999 é necessário utilizar dados reais para que os testes funcionem.

Acompanhe a tela de relatórios

Na tela de relatórios, seja da integração ou da instância, você consegue ter uma ideia geral das notificações que estão sendo enviadas.

Caso não saiba onde fica esta tela, acesse este artigo para saber como verificar os relatórios.


Verifiquei todos os passos acima e mesmo assim acredito que não esteja funcionando.

Nesse caso, temos um checklist mais detalhado que você consegue ver aqui.

Quando as notificações serão disparadas?

Como essa é uma integração instantânea, assim que a plataforma nos enviar as informações, iremos processar e agendar a mensagem na fila de envios. Caso você não saiba o que é uma fila de envios, clique aqui.

Quais são as notificações disponíveis?

Todas as notificações listadas na tabela abaixo estão disponíveis e funcionando. Antes de você conhecê-las, entenda como cada uma delas funciona.

Veja, então, o que significa cada coluna das notificações disponíveis:

  • Prioridade no caminho feliz: se esta função estiver disponível, ela vai indicar a ordem de envio das mensagens seguindo a lógica do chamado “caminho feliz”. Você pode ler mais sobre ele aqui;
  • Nome da notificação: é o nome que damos para a notificação dentro do nosso painel;
  • Como reconhecemos o evento: em algumas integrações, deixamos documentada a maneira como elas são reconhecidas pelo nosso sistema. Isso acontece porque algumas delas podem ser personalizadas. Mas, se o reconhecimento não estiver disponível, pode ficar tranquilo pois isso não afeta qualquer usabilidade do sistema.

Clique na imagem para aumentar