Configurar Webhooks no Apple Business Connect
Um parceiro com acesso de API poderá receber notificações push usando um Webhook para ver mudanças de estado que envolvem diferentes recursos e eventos. Os tipos de notificação recebidos ao usar Webhooks são semelhantes aos da API Notifications.
Nota: Antes de poder usar um Webhook, é necessário ter acesso de API ao Apple Business Connect e cada ambiente deverá ser aprovado pela Apple. Consulte solicitar acesso de API.
Criar seu primeiro Webhook
Se você ainda não tiver uma sessão iniciada no Apple Business Connect, inicie sessão com um usuário que tenha a função de Administrador.
Se você for o administrador de mais de uma companhia, selecione a companhia adequada na lista Companhias
.Selecione sua companhia na barra lateral, depois selecione a API abaixo do nome da companhia.
Selecione
ao lado de Adicionar Webhook e insira as seguintes informações:Informações
Descrição
Webhook
Pode conter letras, números e símbolos, exceto os seguintes:
; (Ponto e vírgula)
’ (Apóstrofo de pontuação)
[ (Colchete esquerdo)
] (Colchete direito)
< (sinal menor que)
> (sinal maior que)
Membro da equipe
Um membro da equipe com a função de Administrador ou Desenvolvedor que possa ser contatado se a conexão falhar
Ambiente
Restrições:
Não é possível alterar ambientes após configurar um Webhook
É possível usar somente um evento por vez por ambiente
URL do payload
Precisa iniciar com https://
Eventos
É necessário selecionar ao menos um recurso ou outro evento
Nota: depois que as informações do Webhook forem adicionadas, uma notificação será enviada ao URL para verificar a conexão.
Selecione Salvar.
Selecione o botão Copiar para copiar o segredo de cliente para a Área de Transferência.
Compartilhe o segredo de cliente com o administrador do Webhook.
Depois que o administrador confirmar que recebeu o segredo de cliente, selecione Concluído.
Editar um Webhook
Se você ainda não tiver uma sessão iniciada no Apple Business Connect, inicie sessão com um usuário que tenha a função de Administrador.
Se você for o administrador de mais de uma companhia, selecione a companhia adequada na lista Companhias
.Selecione sua companhia na barra lateral, depois selecione a API abaixo do nome da companhia.
Selecione
ao lado de Gerenciar Webhooks, depois selecione um Webhook da lista.Você pode alterar o seguinte:
O nome do Webhook
O status do Webhook
O nome de um membro da equipe que pode ser contatado em caso de falha da conexão
O URL do payload
Se necessário, selecione Criar novo segredo de cliente, depois selecione Criar.
Compartilhe o segredo de cliente com o administrador do Webhook.
Depois que o administrador confirmar que recebeu o segredo de cliente, selecione Concluído.
Selecione todos os recursos e eventos sobre os quais deseja receber notificações.
Nota: os recursos usados no mesmo ambiente Webhook não estarão disponíveis em mais de um Webhook.
Selecione Salvar.
Visualizar ou alterar o status de um Webhook.
Se você ainda não tiver uma sessão iniciada no Apple Business Connect, inicie sessão com um usuário que tenha a função de Administrador.
Se você for o administrador de mais de uma companhia, selecione a companhia adequada na lista Companhias
.Selecione sua companhia na barra lateral, depois selecione a API abaixo do nome da companhia.
Selecione
ao lado de Gerenciar Webhooks, depois visualize a lista Webhook.Alterar o status do Webhook para Ativado ou Desativado.
Desativar um Webhook faz com que as notificações não sejam mais enviadas a ele.
Remover um Webhook
Se você ainda não tiver uma sessão iniciada no Apple Business Connect, inicie sessão com um usuário que tenha a função de Administrador.
Se você for o administrador de mais de uma companhia, selecione a companhia adequada na lista Companhias
.Selecione sua companhia na barra lateral, depois selecione a API abaixo do nome da companhia.
Selecione
ao lado de Gerenciar Webhooks, depois visualize a lista Webhook.Selecione um Webhook, depois role a tela para baixo e selecione Remover Webhook.
Selecione Remover e, em seguida, selecione Salvar.