Configurar Webhooks no Apple Business Connect
Um Parceiro terceiro com acesso à API pode receber notificações push utilizando um Webhook relativamente a alterações de estado que envolvam diferentes recursos e eventos. Os tipos de notificações recebidas utilizando Webhooks correspondem aos tipos da API de Notificações.
Nota: Antes de poder utilizar um Webhook, tem de ter acesso à API para o Apple Business Connect e cada ambiente tem de ser aprovado pela Apple. Consulte Pedir acesso à API.
Criar o primeiro Webhook
Se ainda não iniciou sessão, inicie sessão no Apple Business Connect com a conta de uma pessoa com a função de administração.
Se tiver a função de Administrador de mais do que uma empresa, selecione a empresa adequada na lista Empresa
.Selecione a sua empresa na barra lateral e, em seguida, selecione a API por baixo do nome da empresa.
Selecione
junto a Adicionar Webhook e, em seguida, introduza as seguintes informações:Informações
Descrição
Webhook
Pode conter letras, números e símbolos, exceto o seguinte:
; (ponto e vírgula)
’ (apóstrofe de pontuação)
[ (parêntesis reto esquerdo)
] (parêntesis reto direito)
< (sinal inferior a)
> (sinal superior a)
Membro da equipa
Um membro da equipa com a função de administração ou programação que é contactado em caso de falha na ligação
Ambiente
Restrições:
Não é possível alterar os ambientes depois de configurar um Webhook
Cada evento só pode ser gerado uma vez por ambiente
URL da carga útil
Tem de começar com https://
Eventos
Tem de selecionar, pelo menos, um recurso ou outro evento.
Nota: Depois de adicionar as informações do Webhook, é enviado um ping para o URL para confirmar a ligação.
Selecione Guardar.
Selecione o botão Copiar para copiar o segredo de cliente para o Clipboard.
Partilhe o segredo de cliente com o administrador do Webhook.
Depois de o administrador confirmar a receção do segredo de cliente, selecione Terminado.
Editar um Webhook
Se ainda não iniciou sessão, inicie sessão no Apple Business Connect com a conta de uma pessoa com a função de administração.
Se tiver a função de Administrador de mais do que uma empresa, selecione a empresa adequada na lista Empresa
.Selecione a sua empresa na barra lateral e, em seguida, selecione a API por baixo do nome da empresa.
Selecione
junto a Gerir Webhooks e, em seguida, selecione um Webhook na lista.Pode alterar o seguinte:
O nome do Webhook
O estado do Webhook
O nome de um membro da equipa que é contactado em caso de falha da ligação
O URL da carga útil
Se necessário, selecione Criar novo segredo de cliente e, em seguida, selecione Criar.
Partilhe o segredo de cliente com o administrador do Webhook.
Depois de o administrador confirmar a receção do segredo de cliente, selecione Terminado.
Selecione todos os recursos e eventos sobre os quais pretende receber notificações.
Nota: Os recursos utilizados no mesmo ambiente do Webhook só estão disponíveis para um Webhook.
Selecione Guardar.
Consultar ou alterar o estado de um Webhook
Se ainda não iniciou sessão, inicie sessão no Apple Business Connect com a conta de uma pessoa com a função de administração.
Se tiver a função de Administrador de mais do que uma empresa, selecione a empresa adequada na lista Empresa
.Selecione a sua empresa na barra lateral e, em seguida, selecione a API por baixo do nome da empresa.
Selecione
junto a Gerir Webhooks e, em seguida, visualize a lista Webhook.Altere o estado do Webhook para o ativar ou desativar.
Desativar um Webhook para a entrega de notificações ao mesmo.
Remover um Webhook
Se ainda não iniciou sessão, inicie sessão no Apple Business Connect com a conta de uma pessoa com a função de administração.
Se tiver a função de Administrador de mais do que uma empresa, selecione a empresa adequada na lista Empresa
.Selecione a sua empresa na barra lateral e, em seguida, selecione a API por baixo do nome da empresa.
Selecione
junto a Gerir Webhooks e, em seguida, visualize a lista Webhook.Selecione um Webhook e, em seguida, desloque para baixo e selecione Remover Webhook.
Selecione Remover e, em seguida, selecione Guardar.