Uuden webhookin määrittäminen

Määritysasetukset

Webhook-sovelluksen määrittäminen edellyttää viiden elementin määrittelyä:

• Nimi – Suositteleme käyttämään loogista nimeä, jonka muut järjestelmänvalvojat ymmärtävät helposti.
• Käyttöalue - Kuinka isolla verkolla webhook pyydystää? Tili ja Ryhmä ovat saatavana käyttöliittymässä.
  • API tukee Tili-, Ryhmä-, Käyttäjä- ja Resurssi-käyttöalueita.
  • Yhtä webhookia kohti voi määrittää vain yhden käyttöalueen.
• URL - Kohteen URL-osoite, johon Acrobat Sign on työntänyt JSON-kuorman.
• Tapahtumat - Käynnistin, joka saa Acrobat Signin luomaan JSON:in ja työntämään sen URL-osoitteeseen.
  • Jokainen tapahtuma luo laukaisutapahtuman kannalta merkityksellisen hyötykuorman.
  • Yksi webhook voi sisältää monta tapahtumaa.
• Ilmoitusparametrit - Ilmoitusparametrit yksilöivät tapahtuman JSON-hyötykuorman osiot, jolloin voit valita vain ne tapahtuman osiot, jotka ovat kyseiselle webhookille tärkeitä (mikä vähentää tarpeettomien tietojen lähettämistä URL-osoitteeseen).

Kun webhook on määritetty kokonaan, valitse Tallenna, niin uusi webhook alkaa välittömästi reagoida laukaisutapahtumiin. 

Käyttöalueet

• Tili: Kaikki tilillä tehdyt tilaustapahtumat käynnistävät työnnön.
  
  • Tilin ylläpitäjillä on valtuudet nähdä kaikki tilille ja tilin ryhmille määritetyt webhookit.
• Ryhmä: Kaikki ryhmässä tilatut tapahtumat käynnistävät työnnön. HUOM.: Ryhmän laajuiset webhookit ovat olemassa vain kyseiselle ryhmälle.
  • Ryhmien ylläpitäjät näkevät vain oman ryhmänsä webhookit. He eivät näe tilitason webhookeja tai muihin ryhmiin sidottuja webhookeja.
  • Tilit, joilla Käyttäjiä useissa ryhmissä -toiminto on käytössä, näkevät vaihtoehdon, jolla voidaan määrittää ryhmä, johon käyttöaluetta sovelletaan.
    
• Käyttäjätili: Kaikki käyttäjätilin tilatut tapahtumat laukaisevat vaatimuksen. Käyttäjätason webhookit voidaan luoda vain API: n kautta.
• Resurssitason webhook: Tämä luodaan tiettyä resurssia varten. Tähän resurssiin liittyvät tapahtumat siirretään webhookin URL-osoitteeseen. Resurssitason webhookit voidaan luoda vain API:n kautta.

URL

Webhook URL-osoite on palvelin, joka kuuntelee saapuvia HTTPS POST -ilmoitusviestejä, jotka laukeavat tapahtumien sattuessa.

Tarvitset tämän URL-osoitteen tilataksesi webhookisi tapahtumiin.

• Asiakkaan on sisällytettävä HTTPS-URL-osoite, johon Acrobat Sign voi käyttää POST-metodia. Tämän URL-osoitteen on oltava käytettävissä julkisessa verkossa.  
  • Esimerkiksi 127.0.0.1 ja paikalliset isäntä-URI-tunnisteet eivät toimi.
  • URL-päätepisteen on kuunneltava porttia 443 tai 8443 (asiakas päättää asiasta, kun vastakutsun URL-osoitetta määritetään).
• Varmista, että webhook tukee POST-pyyntöjä saapuville tapahtumailmoituksille ja GET-pyyntöjä vahvistuspyynnöille.
• Palomuuri ei saa estää URL-osoitetta.

Tapahtumat

Alla on tapahtumia, jotka voivat käynnistää viennin webhookin URL-osoitteeseen. Ne on ryhmitelty objektin mukaan ja lueteltu käyttöliittymän mukaisessa järjestyksessä.

Vasemmalla on arvo, jonka näet Acrobat Signin käyttöliittymässä. Oikealla oleva arvo on webhookin nimi API:ssa.

Täydelliset tiedot webhookeista ja niiden hyötykuormista löytyvät Acrobat Signin kehittäjäoppaasta.

Sopimukset:

Erälähetys:

Verkkolomakkeet:

Kirjastomallit (vain API):

Ilmoitusparametrit

Ilmoitusparametrien avulla voit mukauttaa JSON-hyötykuorman vain tiettyihin tapahtuman elementteihin.

Esimerkiksi Sopimuksen osallistuja korvattu -tapahtumassa saatat haluta säilyttää vain Sopimustiedot ja Osallistujatiedot ja jättää pois Asiakirjatiedot, mikä vähentää Webhook URL-osoitteeseen lähetetyn JSON:in kokoa.

• Sopimus
  • Sopimustiedot - Yksityiskohtaiset sopimustiedot, jotka perustuvat siihen tilaan, missä sopimus on käynnistävän tapahtuman aikana.
  • Sopimusasiakirjan tiedot - Sisältää kaikki tapahtuman tuloksena syntyneet asiakirjatiedot.
  • Sopimuksen osallistujan tiedot - Sisältää kaikki tapahtuman tuloksena syntyneet osallistujan tiedot.
  • Sopimuksen allekirjoitettu dokumentti - Antaa allekirjoitetun PDF-tiedoston. 
    • Sovelletaan Sopimuksen työnkulku valmis- ja Sopimus Kaikki -tapahtumiin.
• Erälähetys
  
  • Erälähetyksen tiedot - Yksityiskohtaiset tiedot tapahtuman käynnistäneestä erälähetysobjektista.
• Verkkolomake
  • Pienoissovelluksen tiedot – Yksityiskohtaiset tiedot tapahtuman käynnistäneestä verkkolomakkeesta.
  • Pienoissovelluksen asiakirjatiedot - Verkkolomakkeeseen liittyvät asiakirjatiedot.
    
  • Pienoissovelluksen osallistujatiedot - Tietoja verkkolomakkeen osallistujista.