Passar para o conteúdo principal

Quais eventos e APIs compõem a integração?

Eventos que a Linkana emite, APIs disponíveis hoje e o que pode ser ajustado na sua integração.

Escrito por Débora Sampaio

Este artigo é a referência técnica da integração: quais eventos a Linkana emite, quais APIs existem hoje e o que pode ser ajustado no seu projeto. Ele serve para o seu time técnico entender o que a integração consegue transportar.

Importante: nenhum desses pontos é exposto para conexão direta do seu sistema. Eventos e APIs são consumidos pelo middleware que a Linkana desenvolve e mantém para a sua integração, como descrito em Como funciona a integração com a Linkana?.


Como os dados circulam

  1. Algo acontece na Linkana, por exemplo a aprovação de uma homologação

  2. A Linkana emite um evento com os dados do fornecedor

  3. O middleware recebe o evento, aplica as regras e o de-para definidos no seu projeto e grava os dados no seu sistema

  4. Quando o fluxo precisa agir na Linkana, como criar um fornecedor ou devolver o código gerado pelo ERP, o middleware usa as APIs da Linkana

Por que o seu sistema não se conecta diretamente

Além de tratar erros e monitorar os envios, o middleware protege o seu sistema de mudanças do lado da Linkana. Quando um evento ganha campos ou muda de formato, a Linkana ajusta o middleware, e o seu sistema continua recebendo os dados no formato combinado no projeto.


Eventos disponíveis

Evento

Quando é emitido

supplier.added

Fornecedor cadastrado na Linkana, pela plataforma, por API ou pela integração

supplier.blocked

Fornecedor bloqueado ou desbloqueado

supplier.category_score.changed

O score de risco do fornecedor em uma categoria mudou

qualification_temp.created

Homologação iniciada para o fornecedor em uma categoria, inclusive em re-homologação

qualification_temp.approved

Homologação aprovada, ao final das etapas de aprovação

qualification_temp.refused

Homologação reprovada, ao final das etapas de aprovação

document.reviewed

Documento do fornecedor revisado, com resultado aprovado ou reprovado. Emitido apenas para os documentos configurados para isso

A estrutura completa e um exemplo de cada evento estão no catálogo de eventos da Linkana, que é mantido pela Linkana e sempre reflete os eventos ativos.

Lista de eventos atualizada em 09/11/2026.


O que um evento carrega

De forma geral, os eventos trazem:

  • Identificação do fornecedor: identificador na Linkana e CNPJ, CPF ou identificador fiscal estrangeiro

  • Dados do fornecedor: dados cadastrais, incluindo os dados da Receita Federal quando o fornecedor é pessoa jurídica nacional

  • Documentos: apenas os documentos configurados para a integração, com status, validade e as informações coletadas

  • Campos personalizados: os campos personalizados ativos do fornecedor

  • Homologação: nos eventos de homologação, os dados da decisão, como data e motivo

Os documentos e campos que entram na sua integração são definidos na De-Para, durante o projeto.


APIs disponíveis

As APIs da Linkana permitem que o middleware execute ações na plataforma a partir do seu sistema. Hoje existem as seguintes capacidades:

Capacidade

Uso típico

Criar fornecedor

O fornecedor nasce no seu sistema de e-procurement ou ERP e é criado na Linkana para ser homologado

Iniciar re-homologação

O seu sistema solicita uma nova homologação de um fornecedor que já existe na Linkana

Solicitar atualização de formulário

O fornecedor é solicitado a atualizar um formulário

Bloquear fornecedor

Um bloqueio feito no seu sistema é refletido na Linkana

Ler e gravar campos personalizados

O código gerado pelo seu ERP é registrado no painel do fornecedor na Linkana

As APIs da Linkana não são públicas. Elas são consumidas pelo middleware conforme as regras de negócio definidas no levantamento de requisitos do projeto, seja a partir de uma chamada do seu sistema, seja por uma consulta periódica que a Linkana faz ao seu sistema.


O que pode ser ajustado na sua integração

Ajustes dentro do contrato, solicitados a qualquer momento durante a vigência:

  • Quais documentos e campos personalizados entram nos eventos

  • Regras de negócio e de-para

  • Quais eventos disparam o fluxo da sua integração

  • Endereços e credenciais do seu sistema

Para saber como solicitar esses ajustes e em que prazo, veja Como funciona o tratamento de erros e a sustentação da integração?.

Já um evento novo, um dado que hoje não faz parte dos eventos ou uma nova capacidade de API são evoluções do produto. Nesses casos, faça o pedido pelo chat da plataforma: o time da Linkana avalia a solicitação e retorna com a viabilidade.


Leia também

Respondeu à sua pergunta?