Ir para o conteúdo

Eventos da API

Onde encontro os eventos da API?

Acesse nossa documentação da API e, no canto inferior esquerdo, clique em Eventos API:

option-events-api

Em seguida, vão ser abertos todos os eventos da API:

all-events-api

Onde acho o payload dos eventos?

Após abrir todos os eventos, clique naquele que deseja:

option-event

Agora, no canto direito da tela, é possível ver o Payload do evento:

payload-event

Como utilizo o payload de cada evento?

O payload são os campos que o evento precisa. Como exemplo, vou utilizar o payload de pedido pago. Confira:

payload

Esse payload tem o campo customer e, dentro dele, existem vários campos então vai ficar assim:

Aviso

No campo customer[phone] é necessário que deixe o seu telefone no formato E.164: +5531999999999

  • customer[first_name];
  • customer[last_name];
  • customer[phone];
  • customer[email];
  • order[id];
  • order[products_total];
  • order[total];
  • order[discount];
  • order[products][0][name];
  • order[products][0][quantity];
  • order[products][0][value];
  • order[delivery][fee];
  • order[delivery][description].

O campo order[producsts][0] possui o [0] porque é um array. A regra segue para qualquer payload com array, como você vê abaixo:

products

Agora, o order[delivery] é um objeto:

delivery

Onde encontro a URL de um evento?

Após escolher o evento que deseja, no canto superior direito da tela você vai encontrar a URL do evento:

url-event

Você pode verificar o tipo do evento, como mostra a imagem:

event-type

Agora, clique nessa URL para conseguir copiar-lá:

event-url-copy

Como achar o ID da integração para colocar na URL?

Na URL do evento, existe um campo assim {integrationId}. Nele, vamos colocar o número da sua integração. Para isso, siga os passos abaixo.

Acesse a sua integração da API no Notificações Inteligentes e procure o campo Como fazer a integração:

option-how-to-integrate

Na URL, você consegue encontrar o número da sua integração:

url-number

Agora, vamos colocar esse número na URL do evento como no exemplo a seguir:

Essa é a URL do evento de pedido pago: https://api.notificacoesinteligentes.com/integrations/{integrationId}/events/order-paid.

No campo {integrationId}, vamos trocar o dado pelo número da sua integração. Então, vai ficar assim: https://api.notificacoesinteligentes.com/integrations/493/events/order-paid.

Atenção

O número 493 é apenas de exemplo! Utilize o número da sua integração no lugar do 493, está bem?

Onde ficam os Headers?

Após escolher o evento que deseja, você pode encontrar os Headers:

headers

Como identifico a autorização do evento?

Após escolher o evento, você pode encontrar o tipo de autorização do evento. Aqui é utilizado o tipo Bearer:

bearer-token

Para saber qual a sua token, acesse sua conta do Notificações Inteligentes e no canto superior direito, clique no seu nome:

dashboard-name

Agora, clique em Configurações:

configurations

Procure o campo Chave de API:

api-key

Caso você não tenha uma chave da API, clique em Gerar nova chave:

generate-api-key

Pronto! Essa é sua token.

Sempre que quiser saber qual a chave de autorização do evento, utilize o tipo + token:

  • Bearer d1r2a3g4o5n6b7a8l9l0z.

Última atualização: 25 de fevereiro de 2021 12:50:18