Käyttöopas Peruuta

Uuden webhookin määrittäminen

 

Adobe Acrobat Sign -opas

Uudet ominaisuudet

Aloita käyttö

Hallinnoi

Sopimusten lähetys, allekirjoitus ja hallinta

Edistyneet sopimustoiminnot ja -työnkulut

Muihin tuotteisiin integrointi

Acrobat Sign Developer

Tuotetuki ja vianetsintä

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. 

Huomautus:

Määritä webhookin URL-osoite vastaamaan webhookin vahvistus- ja webhookin ilmoituspyyntöihin yllä kuvatun vahvistuskäytännön mukaisesti. Acrobat Sign -verkkosovelluksesta luotuihin webhookeihin lähetettävä asiakastunnus (sovellustunnus) on - UB7E5BXCXY

Määritä webhook

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:

Käyttöliittymäelementti Webhookin nimi
Sopimus, kaikki tapahtumat AGREEMENT_ALL
Sopimus on luotu AGREEMENT_CREATED
Sopimus lähetetty AGREEMENT_ACTION_REQUESTED
Sopimuksen osallistuja on valmis AGREEMENT_ACTION_COMPLETED
Sopimuksen työnkulku on suoritettu AGREEMENT_WORKFLOW_COMPLETED
Sopimus on vanhentunut AGREEMENT_EXPIRED
Sopimus on poistettu AGREEMENT_DOCUMENTS_DELETED
Sopimus peruutettu AGREEMENT_RECALLED
Sopimus on hylätty AGREEMENT_REJECTED
Sopimus on jaettu AGREEMENT_SHARED
Sopimuksen jako poistettu AGREEMENT_UNSHARE
Sopimuksen jako poistettu automaattisesti AGREEMENT_UNSHARE_AUTO
Sopimus on delegoitu AGREEMENT_ACTION_DELEGATED
Sopimuksen osallistuja on korvattu AGREEMENT_ACTION_REPLACED_SIGNER
Sopimusta on muutettu AGREEMENT_MODIFIED
Sopimuksen muutos on kuitattu AGREEMENT_USER_ACK_AGREEMENT_MODIFIED
Sopimussähköpostiviestiä on tarkasteltu AGREEMENT_EMAIL_VIEWED
Sopimussähköpostiviestin toimitus epäonnistui AGREEMENT_EMAIL_BOUNCED
Sopimusasiakirja katsottu AGREEMENT_DOCUMENTS_VIEWED
Sopimusasiakirja katsottu, kun asiakirjan tarkasteluun on käytetty salasanaa AGREEMENT_DOCUMENTS_VIEWED_PASSWORD_PROTECTED
Sopimuksen luonti epäonnistui AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
Sopimus on synkronoitu offline-tapahtuman jälkeen AGREEMENT_OFFLINE_SYNC
Sopimus on tallennettu säilöön AGREEMENT_VAULTED
Sopimukseen osallistujan henkilöllisyys on todennettu AGREEMENT_WEB_IDENTITY_AUTHENTICATED
Sopimuksen osallistuja on todennettu tietoon perustuvalla todennuksella AGREEMENT_KBA_AUTHENTICATED
Sopimuksen osapuolen sähköposti-OTP todennettu
AGREEMENT_EMAIL_OTP_AUTHENTICATED
Sopimuksen vanhentumispäivä päivitetty AGREEMENT_EXPIRATION_UPDATED
Sopimusmuistutus on lähetetty AGREEMENT_REMINDER_SENT
Allekirjoittaja on muuttanut sopimuksen allekirjoittajan nimeä AGREEMENT_SIGNER_NAME_CHANGED_BY_SIGNER
Sopimusmuistutus aloitettu AGREEMENT_REMINDER_INITIATED
   
Sopimuksen webhookit ovat saatavana vain API:n kautta
Käyttöliittymäelementti Webhookin nimi
PUUTTUU
AGREEMENT_READY_TO_NOTARIZE
PUUTTUU
AGREEMENT_READY_TO_VAULT

 

Erälähetys:

Käyttöliittymäelementti Webhookin nimi
Erälähetä kaikki tapahtumat MEGASIGN_ALL
Erälähetys luotu
MEGASIGN_CREATED
Erälähetys jaettu
MEGASIGN_SHARED
Erälähetys peruttu
MEGASIGN_RECALLED
Erälähetysmuistutus lähetetty MEGASIGN_REMINDER_SENT
Erälähetysmuistutus aloitettu MEGASIGN_REMINDER_INITIATED

 

Verkkolomakkeet:

Käyttöliittymäelementti Webhookin nimi
Verkkolomake kaikki tapahtumat WIDGET_ALL
Verkkolomake on luotu.
WIDGET_CREATED
Verkkolomake on otettu käyttöön
WIDGET_ENABLED
Verkkolomake on poistettu käytöstä
WIDGET_DISABLED
Verkkolomaketta on muutettu
WIDGET_MODIFIED
Verkkolomake on jaettu
WIDGET_SHARED
Verkkolomakkeen luonti epäonnistui
WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM

 

Kirjastomallit (vain API):

Käyttöliittymäelementti Webhookin nimi
PUUTTUU LIBRARY_DOCUMENT_ALL
PUUTTUU LIBRARY_DOCUMENT_CREATED
PUUTTUU LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
PUUTTUU LIBRARY_DOCUMENT_MODIFIED

 

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.

Pyydä apua nopeammin ja helpommin

Oletko uusi käyttäjä?