Webhookien ottaminen käyttöön Apple Business Connectissa
Ohjelmointirajapintaa käyttävä ulkopuolinen kumppani voi webhookia käyttämällä saada push-ilmoituksia tilamuutoksista, joihin liittyy erilaisia resursseja ja tapahtumia. Webhookin avulla vastaanotettujen ilmoitusten tyypit vastaavat Ilmoitukset-ohjelmointirajapinnan tyyppejä.
Huomaa: Ennen kuin voit käyttää webhookia, sinulla on oltava Apple Business Connectin käyttöoikeus ohjelmointirajapinnan kautta ja kaikkien ympäristöjen on oltava Applen hyväksymiä. Katso kohta Pyydä käyttöoikeutta ohjelmointirajapintaan.
Ensimmäisen webhookin luominen
Jos et ole jo kirjautunut sisään Apple Business Connectiin, kirjaudu sisään käyttäjänä, jolla on ylläpitäjän rooli.
Jos olet useamman kuin yhden yhtiön ylläpitäjä, valitse asianmukainen yhtiö Yhtiö-luettelosta
.Valitse yhtiösi sivupalkista ja sitten yhtiön nimen alta API.
Valitse kohdan Lisää webhook vierestä
ja anna seuraavat tiedot:Tiedot
Kuvaus
Webhook
Voi sisältää kirjaimia, numeroita ja erikoismerkkejä lukuun ottamatta seuraavia:
; (puolipiste)
’ (heittomerkki)
[ (vasen hakasulku)
] (oikea hakasulku)
< (pienempi kuin ‑merkki)
> (suurempi kuin ‑merkki)
Tiimin jäsen
Tiimin jäsen, jonka rooli on ylläpitäjä tai kehittäjä ja johon otetaan yhteyttä yhteysongelmien sattuessa
Ympäristö
Rajoitukset:
Et voi vaihtaa ympäristöä, kun webhook on otettu käyttöön.
Tapahtumaa voi käyttää vain kerran kussakin ympäristössä.
Tietosisällön URL
Alun on oltava https://
Tapahtumat
Vähintään yksi resurssi tai muu tapahtuma täytyy valita.
Huomaa: webhookin lisäämisen jälkeen URL-osoitteeseen lähetetään ping yhteyden vahvistamiseksi.
Valitse Tallenna.
Kopioi asiakkaan salainen avain leikepöydälle valitsemalla Kopioi-painike.
Ilmoita asiakkaan salainen avain webhookin ylläpitäjälle.
Kun ylläpitäjä on vahvistanut saaneensa asiakkaan salaisen avaimen, valitse Valmis.
Webhookin muokkaaminen
Jos et ole jo kirjautunut sisään Apple Business Connectiin, kirjaudu sisään käyttäjänä, jolla on ylläpitäjän rooli.
Jos olet useamman kuin yhden yhtiön ylläpitäjä, valitse asianmukainen yhtiö Yhtiö-luettelosta
.Valitse sivupalkista yhtiö ja sitten yhtiön nimen alta API.
Valitse kohdan Hallitse webhookeja vierestä
ja valitse sitten webhook luettelosta.Voit muuttaa seuraavia:
webhookin nimi
webhookin tila
sen tiimin jäsenen nimi, johon otetaan yhteyttä yhteysongelmien sattuessa
tietosisällön URL.
Valitse tarvittaessa Luo uusi asiakkaan salainen avain ja sitten Luo.
Ilmoita asiakkaan salainen avain webhookin ylläpitäjälle.
Kun ylläpitäjä on vahvistanut saaneensa asiakkaan salaisen avaimen, valitse Valmis.
Valitse kaikki resurssit ja tapahtumat, joista haluat saada ilmoituksia.
Huomaa: samassa webhook-ympäristössä käytetyt resurssit eivät ole useamman kuin yhden webhookin käytettävissä.
Valitse Tallenna.
Webhookin tilan tarkastaminen ja muuttaminen
Jos et ole jo kirjautunut sisään Apple Business Connectiin, kirjaudu sisään käyttäjänä, jolla on ylläpitäjän rooli.
Jos olet useamman kuin yhden yhtiön ylläpitäjä, valitse asianmukainen yhtiö Yhtiö-luettelosta
.Valitse sivupalkista yhtiö ja sitten yhtiön nimen alta API.
Valitse kohdan Hallitse webhookeja vierestä
, jotta pääset tarkastelemaan webhook-luetteloa.Kytke webhook päälle tai pois päältä muuttamalla sen tilaa.
Webhookin kytkeminen pois päältä lopettaa ilmoitusten toimittamisen sille.
Webhookin poistaminen
Jos et ole jo kirjautunut sisään Apple Business Connectiin, kirjaudu sisään käyttäjänä, jolla on ylläpitäjän rooli.
Jos olet useamman kuin yhden yhtiön ylläpitäjä, valitse asianmukainen yhtiö Yhtiö-luettelosta
.Valitse sivupalkista yhtiö ja sitten yhtiön nimen alta API.
Valitse kohdan Hallitse webhookeja vierestä
, jotta pääset tarkastelemaan webhook-luetteloa.Valitse webhook, selaa sitten alas ja valitse Poista webhook.
Valitse Poista ja sitten Tallenna.