Pular para o conteúdo
POST

/v1/fiscal/webhooks/{provider}

Aviso do provedor de emissão (webhook)

Chamado pelo provedor quando uma nota muda de situação (não é para uso do painel). Autenticação: Authorization com o segredo combinado (com ou sem o prefixo Bearer) (comparação em tempo constante; sem segredo configurado a rota responde 503). O aviso é gravado antes de processar, com id determinístico (repetição não repete efeito), e nunca é aceito como verdade: a API consulta a nota no provedor pela referência antes de mudar qualquer estado.

Autenticação

Envie o token de acesso do usuário no cabeçalho Authorization. Como autenticar

Authorization: Bearer <TOKEN>

Parâmetros

Parâmetros de caminho

  • providerstringObrigatório

    Padrão (regex): ^[a-z0-9-]{2,32}$

Corpo da requisição

application/json · obrigatório

JSON
{}

Exemplo de requisição

Gerado do contrato. Troque os marcadores entre < > pelos seus valores.

const res = await fetch("https://myclinc.leadpoint.com.br/v1/fiscal/webhooks/<provider>", {  method: "POST",  headers: {    Authorization: "Bearer <TOKEN>",    "Content-Type": "application/json",  },  body: JSON.stringify({}),})​if (!res.ok) {  const { error } = await res.json()  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()

Resposta

200OK — Sucesso.
JSON
{  "data": {    "status": "processado"  }}

Exemplo gerado do esquema da resposta; valores entre < > são ilustrativos.

Códigos de erro

Corpo no formato padrão { error: { code, message, requestId } }. Veja todos os códigos.

400

Bad Request — Requisição malformada (JSON inválido, cursor inválido ou clínica ativa não informada).

401

Unauthorized — Token ausente, inválido ou expirado.

403

Forbidden — Autenticado, mas sem permissão (perfil ou clínica).

404

Not Found — Recurso não encontrado na clínica ativa.

422

Unprocessable Entity — Dados semanticamente inválidos (erros por campo em details).

429

Too Many Requests — Limite de requisições excedido (veja Retry-After).

500

Internal Server Error — Erro interno (sem detalhes expostos).

503

Service Unavailable — Banco de dados indisponível ou não configurado.

Limites

Limite padrão: 120 requisições a cada 60 segundos por token. Sobre limites