Configurare webhook in Apple Business Connect
Un partner di terze parti con accesso API può ricevere notifiche push mediante un webhook per le modifiche di stato che riguardano vari eventi e risorse. I tipi di notifica ricevuti tramite webhook corrispondono a quelli dell'API Notifications.
Nota: Prima di usare un webhook, devi avere un accesso API a Apple Business Connect e ciascun ambiente deve essere approvato da Apple. Consulta Richiedere l'accesso API.
Creare il tuo primo webhook
Se non lo hai già fatto, accedi ad Apple Business Connect con un utente con il ruolo di Responsabile impresa.
Se rivesti il ruolo di Amministratore o Amministratrice per più di un’impresa, seleziona quella opportuna nell’apposito elenco
.Seleziona la tua impresa nella barra laterale, quindi seleziona API sotto il nome dell'impresa.
Seleziona
accanto ad Aggiungi webhook, quindi inserisci le seguenti informazioni:Informazioni
Descrizione
Webhook
Può contenere lettere, numeri e simboli, ad eccezione di quanto segue:
; (punto e virgola)
' (apostrofo)
[ (parentesi quadra sinistra)
[ (parentesi quadra destra)
< (segno inferiore a)
> (segno superiore a)
Membro del team
Un membro del team con il ruolo di Responsabile o Sviluppo che viene contattato in caso di errore nella connessione
Ambiente
Limitazioni:
Non puoi modificare gli ambienti dopo la configurazione di un webhook
Un evento può essere usato una sola volta per ambiente
URL payload
Deve iniziare con https://
Eventi
Devi selezionare almeno una risorsa o un altro evento
Nota: Una volta aggiunte le informazioni del webhook, viene inviato un ping all'URL per verificare la connessione.
Seleziona Salva.
Seleziona il pulsante Copia per copiare il segreto client negli appunti.
Condividi il segreto client con l'amministratore del webhook.
Una volta che l'amministratore ha confermato di aver ricevuto il segreto client, seleziona Fine.
Modificare un webhook
Se non lo hai già fatto, accedi ad Apple Business Connect con un utente con il ruolo di Responsabile impresa.
Se rivesti il ruolo di Amministratore o Amministratrice per più di un’impresa, seleziona quella opportuna nell’apposito elenco
.Seleziona la tua impresa nella barra laterale, quindi seleziona API sotto il nome dell'impresa.
Seleziona
accanto a Gestisci webhook, quindi selezionane uno dall'elenco.Puoi modificare quanto segue:
Il nome del webhook
Lo stato del webhook
Il nome del membro del team contattato in caso di errore nella connessione
L'URL payload
Se necessario, seleziona Crea nuovo segreto client, quindi Crea.
Condividi il segreto client con l'amministratore del webhook.
Una volta che l'amministratore ha confermato di aver ricevuto il segreto client, seleziona Fine.
Seleziona tutte le risorse e gli eventi per cui desideri ricevere una notifica.
Nota: le risorse utilizzate nello stesso ambiente webhook non sono disponibili in più di un webhook.
Seleziona Salva.
Visualizzare o modificare lo stato di un webhook
Se non lo hai già fatto, accedi ad Apple Business Connect con un utente con il ruolo di Responsabile impresa.
Se rivesti il ruolo di Amministratore o Amministratrice per più di un’impresa, seleziona quella opportuna nell’apposito elenco
.Seleziona la tua impresa nella barra laterale, quindi seleziona API sotto il nome dell'impresa.
Seleziona
accanto a Gestisci webhook per visualizzare l'elenco dei webhook.Modifica lo stato del webhook per attivarlo o disattivarlo.
La disattivazione del webhook arresta l'invio delle notifiche.
Rimuovere un webhook
Se non lo hai già fatto, accedi ad Apple Business Connect con un utente con il ruolo di Responsabile impresa.
Se rivesti il ruolo di Amministratore o Amministratrice per più di un’impresa, seleziona quella opportuna nell’apposito elenco
.Seleziona la tua impresa nella barra laterale, quindi seleziona API sotto il nome dell'impresa.
Seleziona
accanto a Gestisci webhook per visualizzare l'elenco dei webhook.Seleziona un webhook, scorri in basso e seleziona Rimuovi webhook.
Seleziona Rimuovi, quindi Salva.