🗣️Conceitos

Nosso mecanismo de notificação funciona através de Webhooks.

Webhook é um serviço que cria uma conexão para que o seu sistema possa receber informações do plataforma assim que uma determinada ação ocorrer, nomeada como evento nessa documentação.

Funcionamento

O seu sistema pode receber atualização de eventos que ocorreram na nossa plataforma para que não precise consultar a nossa API periodicamente e apenas acessá-la quando se fizer necessário.

Para isso, é necessário que o seu sistema contenha um recurso que receberá a requisição HTTP com o conteúdo da notificação escolhida e previamente configurada na nossa plataforma através do contato com o nosos time.

Cada notificação será enviada apenas UMA vez para o seu recurso, portanto, pedimos que mantenha-os atualizados e disponíveis a todo momento!

Ambiente

A disponibilização dos seus recursos que irão receber as notificações deverão sempre considerar duas variáveis a serem configuradas na nossa plataforma:

• URL base do seu recurso

  • variável {your_url_base}

• Caminho de rota do seu recurso

  • variável {your_url_path}

• (opcional) Uma chave de cabeçalho da requisição (Header)

  • variável {your_header_key}

• (opcional) Um valor estático de cabeçalho da requisição (Header)

  • variável {your_header_value}

É importante reforçar que se definido uma chave e valor de cabeçalho da requisição (Header), ela deverá ser estática, ou seja, a plataforma não executará nenhum processo adicional a não ser passar as informações definidas no cabeçalho da requisição (Header) em questão!

Método e Conteúdo

Utilizaremos sempre o método POST para as requisições, portanto, é obrigatório que o seu recurso aceite esse método.

Os conteúdos das nossas notificações sempre serão enviados com a utilização de JSON (Content-Type application/json) no corpo das requisições para o seu sistema.

O retorno esperado do recurso no seu sistema deve seguir as seguintes regras de códigos de status:

• 200 OK

  • Notificação recebida com sucesso

• 201 Created

  • Notificação recebida com sucesso

• 400 Bad Request

  • Erro no recebimento da notificação

• 429 Too Many Requests

  • Limite atingido no recurso responsável pelo recebimento da notificação

• 500 Internal Server Error

  • Indisponibilidade no recurso responsável pelo recebimento da notificação

Ferramentas

Indicamos que sempre seja utilizado ferramentas que tem como objetivo para testar os recursos disponibilizados através do envio de requisições HTTP para análise do seu envio e retorno, antes mesmo de iniciar o desenvolvimento ou ajuste no seu sistema.

Considerando isso, disponibilizamos abaixo o link de acesso aos exemplos das requisições (collections) através da ferramenta Postman.

Postman

Para as notificações, utilizar a collection Estoca Notifications (v1)