APIs e webhooks
Permite que outros sistemas do grupo, como site, contabilidade e relatórios, leiam e gravem dados no BOX CORPORATE e sejam avisados quando algo acontece. Só o administrador do grupo usa esta tela.
Passo a passo
Criar uma chave
Na aba Chaves de API, clique em Nova chave. Diga para qual sistema é, marque o que ela pode fazer e, se quiser, a data em que ela vence. Clique em Criar chave.
Guardar a chave
Copie a chave e guarde em local seguro. Ela não aparece de novo. Se perder, revogue e crie outra.
Cancelar uma chave
Clique em Revogar. O sistema que usa essa chave perde o acesso na hora. Não dá para desfazer.
Criar um aviso automático
Na aba Webhooks, clique em Novo webhook. Informe o nome, o endereço do seu sistema e os eventos que devem gerar aviso. Guarde o segredo que aparece ao criar.
Testar
Clique em Testar para mandar um aviso de teste e ver se o endereço respondeu.
Ver o que foi enviado
Clique em Entregas para ver cada aviso e a situação dele. Use Reenviar para mandar de novo.
Passar para o time técnico
A aba Documentação traz os detalhes que o responsável técnico do seu sistema precisa.
O que cada situação significa
- AtivaA chave está funcionando.
- VencidaA chave passou da data de validade.
- RevogadaA chave foi cancelada.
- Dono sem acessoQuem criou a chave perdeu o acesso ao grupo, e a chave parou de funcionar.
- EntregueO aviso chegou ao seu sistema.
- PendenteO aviso não chegou ainda e o sistema vai tentar de novo.
- EnviandoO aviso está sendo enviado agora.
- DesistiuAs tentativas acabaram e o aviso não foi entregue.
Se algo não sair como esperado
- Aparece Só o administrador do grupo.Peça ao administrador do grupo para criar a chave ou o webhook.
- O endereço do webhook não é aceito.Ele precisa ser público e começar com https.
- Perdi o segredo do webhook.Abra o webhook em Editar e clique em Gerar novo segredo. O anterior deixa de valer na hora.
Dicas
- Crie uma chave para cada sistema, só com o que ele precisa fazer.
- A chave age com o acesso de quem a criou.
- Cada chave aceita até 120 chamadas por minuto.