Ir para o conteúdo principal
Todos os guias

Configurações e colaboração

Conecte outros softwares

Use chaves de API para acesso e webhooks para notificações de atualização.

Nesta página
  1. Quando você precisa de uma integração?
  2. Crie uma chave de API da 2novel
  3. Receba notificações de webhook
  4. Troque segredos e recupere entregas

Quando você precisa de uma integração?

Use Integrações quando um script, um bot ou outro sistema precisar trabalhar com a 2novel. Traduzir e editar no aplicativo não exige chave de API nem webhook.

Crie uma chave de API da 2novel

Vá em Configurações → Integrações → Chaves de API da 2novel. O acesso depende dos recursos do seu workspace.

  1. Crie uma chave e dê a ela o nome do software que a usará.
  2. Copie-a durante a exibição única e guarde-a em um cofre de segredos ou na configuração privada do receptor. Nunca a coloque em código de frontend público.
  3. Use a referência da API para fazer requisições autenticadas.
  4. Revogue as chaves não utilizadas. Se uma chave for perdida, crie uma nova; não é possível ver de novo o texto da chave antiga.

Receba notificações de webhook

Um webhook avisa que um livro teve atualizações; ele não contém o texto completo dos capítulos. Seu receptor usa a API para buscar os dados de que precisa.

  1. Abra Notificações de webhook e cadastre um endpoint HTTPS público que você controla.
  2. Selecione os eventos de que o seu receptor precisa.
  3. Guarde o segredo de assinatura mostrado uma única vez e configure a verificação de assinatura no seu receptor.
  4. Envie um teste, inspecione o código de resposta e confira os logs do receptor. Uma resposta bem-sucedida, sozinha, não prova a verificação da assinatura.
  5. Acompanhe o status das entregas. Pause durante manutenções e retome quando o receptor estiver pronto.

Troque segredos e recupere entregas

Trocar um segredo de assinatura exige que o receptor use o novo segredo; atualize-o logo. Excluir um webhook interrompe as entregas seguintes. Consulte a referência da API para a verificação de assinatura sobre o corpo bruto e o tratamento das respostas.

Abrir a referência da API

Leia a seguir

Precisa de mais ajuda?

Informe a etapa em que você estava e a mensagem de erro. Nunca envie senhas, chaves de API ou segredos de assinatura de webhook.

Abrir o suporte