Pular para o conteúdo principal
Uma editora que licencia seu conteúdo para a Telepatia pode informar à Telepatia quando um documento muda. A Telepatia busca a nova versão na API da editora, prepara e serve essa versão na biblioteca de conhecimento. O Telepatia Intelligence cita a nova versão nas próximas respostas. A notificação leva apenas o id do documento. Ela nunca leva conteúdo nem uma URL. A Telepatia busca o documento na fonte que a editora e a Telepatia combinaram.

Antes de começar

Você precisa de duas coisas da Telepatia:
  1. Uma API key com a permissão de editora. A key tem library:notify:<publisher>, por exemplo library:notify:moc. Uma key sem essa permissão recebe 403. Uma key notifica para uma única editora.
  2. O id de documento combinado. Cada documento tem um externalId: o seu próprio id para ele. A Telepatia e você combinam o formato desse id uma vez. A Telepatia guarda o id em cada documento.

Enviar uma notificação

Envie uma requisição cada vez que um documento muda:
Uma resposta 202 Accepted significa que a Telepatia enfileirou a notificação:

O que a Telepatia faz

  1. A Telepatia busca o documento na sua API.
  2. Quando o conteúdo é igual à versão que a Telepatia serve, nada muda.
  3. Quando o conteúdo é diferente, a Telepatia guarda como uma nova versão e prepara essa versão. A versão atual continua em serviço até a nova versão ficar pronta.
  4. Quando a Telepatia ainda não tem o documento, a Telepatia adiciona o documento à biblioteca.
As notificações do mesmo documento são processadas uma após a outra, na ordem em que chegam.

Novas tentativas

  • Uma nova tentativa com o mesmo eventId é segura. A Telepatia processa cada eventId uma vez.
  • Com 503, tente de novo com o mesmo eventId. Use uma espera crescente, por exemplo 1, 5 e 30 minutos.
  • Não tente de novo com 400, 401 ou 403. Corrija primeiro a requisição ou a key.