API e webhooks
API e webhooks para a base conversar com os seus sistemas
Pela API do DeepMiner, os seus sistemas enviam registros em JSON para um índice, autenticados com o token de login, e a importação aparece no histórico com a origem API. Cada usuário também gera chaves de API para a API de integração. No sentido contrário, cada provedor configurado ganha uma URL de webhook própria: os eventos de status chegam por ela, encontram o registro correspondente e atualizam o status, com histórico dos últimos eventos em cada registro.
O que você faz
Importação pela API, chave de API por usuário para a integração e webhook de retorno por provedor.
-
Chave de API por usuário
Cada usuário gera as próprias chaves na tela Chave de API para usar na API de integração. A chave carrega o parceiro do usuário, então a integração só enxerga os dados desse parceiro.
-
Importação por API
Com o token de login, envie uma lista de registros em JSON para um índice. Eles seguem o schema, o campo-chave evita duplicatas e o progresso aparece como o de um arquivo.
-
Uma URL de webhook por provedor
A URL é criada com um token aleatório e mostrada uma única vez. O DeepMiner guarda só uma assinatura do token, e regenerar invalida a URL anterior.
-
Retorno no registro certo
Cada evento é casado com o registro de origem. O status do canal, a data da atualização e os campos do evento definidos para aquele tipo de provedor entram no registro, e o evento vai para o histórico.
-
Log de cada evento
O log de webhooks mostra cada evento recebido como processado, duplicado, sem correspondência ou com falha, com o payload para conferência.
Entrada: registros pela API
Quando a base nasce em outro sistema, a API evita a exportação manual. O sistema se autentica com o token de login de um usuário, envia os registros em JSON para o índice e a importação segue o mesmo caminho de um arquivo: validação pelo schema, atualização pelo campo-chave e progresso acompanhado. No Histórico de Importação, a origem aparece como API.
A chave de API, gerada por cada usuário na tela Chave de API, é a credencial da API de integração e carrega o parceiro do usuário. Os dados de um parceiro nunca aparecem para outro, pela API ou pela interface.
Saída: o retorno de cada disparo
Quando você configura um provedor, o DeepMiner gera a URL de webhook dele e mostra uma vez para você copiar e colar no painel do provedor. Depois disso, o token não aparece mais. Se precisar trocar, Regenerar token cria outro e a URL anterior para de funcionar.
Cada evento que chega é colocado numa fila e processado em seguida. O DeepMiner confere se o provedor continua ativo, encontra o registro pela referência do envio ou pelo identificador da mensagem e atualiza o status do canal. O histórico do registro guarda os últimos eventos, e eventos repetidos não são aplicados duas vezes.
O que isso muda na operação
Com o retorno dentro do registro, o status de cada envio aparece na lista de registros do índice e no histórico Eventos dos provedores. A planilha de retorno exportada do painel do provedor deixa de ser necessária para conferir quem recebeu.
Perguntas frequentes
API e webhooks
Como autentico na API?
A importação pela API usa o token de login do usuário. A chave de API, gerada na tela Chave de API, serve à API de integração. As duas pertencem a um usuário e ficam restritas ao parceiro dele.
O webhook responde rápido ao provedor?
Sim. O recebimento só confere o token e coloca o evento numa fila. O processamento acontece em seguida, fora da requisição do provedor.
E se o provedor mandar o mesmo evento duas vezes?
O DeepMiner reconhece o evento repetido e registra como duplicado, sem aplicar a mesma atualização de novo.
Um parceiro consegue ver os dados de outro pela API?
Não. A plataforma é multi-tenant e cada chamada fica restrita ao parceiro do usuário.
Onde vejo os eventos de um registro?
No detalhe do registro, na seção Eventos dos provedores, com o status e o payload de cada evento.
Veja o DeepMiner trabalhando na sua base.
Agende uma demonstração e acompanhe uma base ser indexada, enriquecida e consultada.