Adobe Acrobat Sign API – UKK

1. Kirjaudu Acrobat Signiin.
2. Siirry kohtaan Acrobat Sign API > Rest API -dokumentaatio.
3. Valitse Versio 5.
4. Käytä post /users -menetelmän alla pyyntökoodia, joka on mainittu kohdassa
   UserCreationInfo method
   {
   "email": "email@email.com",
   "firstName": "AA",
   "lastName": "AB",
   "password":"12******rte"
   }

Acrobat Sign -tilit, jotka käyttävät Admin Consolea (Adobe Onea) käyttöoikeuksien hallintaan, eivät voi käyttää Acrobat Sign API:a käyttäjien luontiin tai nykyisten käyttäjien hallintaan.

Adobe One Admin Console käyttää eri API:a kuin Acrobat Sign API. Saat lisätietoja näistä artikkeleista:

• https://helpx.adobe.com/fi/enterprise/help/users.html
• https://developer.adobe.com/umapi/

Ryhmätunnuksen hakeminen:

Ryhmän poistaminen:

Tilapäisen dokumentin luominen

Sopimuksen luominen tilapäisen dokumentin avulla

Voit lisätä tiedostoja FileInfo-parametriin seuraavasti:

POST /agreements -kutsussa allekirjoittamisen signatureflow-parametrina voi olla SENDER_SIGNS_FIRST tai SENDER_SIGNS_LAST -arvo lähettäjän lisäämiseksi ensimmäiseksi tai viimeiseksi allekirjoittajaksi.

Tässä on esimerkki kutsusta JSON-muodossa:

{

  "documentCreationInfo": {

    "fileInfos": [

      {        "transientDocumentId":"3AAABLblqZ-yourIDGoesHere"

      }

    ],

    "name": "Test",

    "recipientSetInfos": [

      {

        "recipientSetMemberInfos": [

          {

            "email": "test@email.com"

          }

        ],

        "recipientSetRole": "SIGNER"

      }

    ],

    "signatureType": "ESIGN",

    "signatureFlow": "SENDER_SIGNS_FIRST"

  }

}

Jos haluat käyttää Lähetä jonkun puolesta -toimintoa, ota Edistyksellinen tilin jako -toiminto tiliä varten käyttöön, jotta käyttäjät voivat myöntää lähetysoikeudet muille käyttäjille, kun he jakavat tilinsä. Lisätietoja edistyneestä jakamisesta on kohdassa Edistyneen tilin jakamisen ottaminen käyttöön.

Kun Käyttäjän jakaminen on otettu käyttöön, suorita seuraavat toimet lähettääksesi jonkun toisen puolesta:

Tilapäisen dokumentin luominen:

Sopimuksen luominen tilapäisen dokumentin avulla:

Seuraavat parametrit voit syöttää koodiin avaussalasanan asettamisteksi:

Luo sopimus API:n avulla AUTHORING-tilassa seuraavasi:

Siirry Post /agreements -kohtaan ja luo käyttöoikeustunnus tarvittavilla käyttöalueilla.

Käytä pyyntökoodia seuraavasti:

v6 sisältää joukon API:itä sopimuksen luontia varten. v5:ssä formFields-kenttiä käytetään suoraan POST /agreements API:ssä. v6:ssa käyttäjä voi kuitenkin luoda sopimuksen AUTHORING-tilassa (state = AUTHORING) v6 POST /agreements -kohdassa ja käyttää PUT /agreements/ID/formFields -parametria milloin tahansa myöhemmin lomakekenttien lisäämiseksi tämän sopimuksen dokumentteihin.

Toimi seuraavasti:

Luo sopimus POST /agreements -komennolla. Lähettää sopimuksen allekirjoitettavaksi ja palauttaa vastauksessa agreementID-tunnuksen asiakkaalle. Alla on JSON-muoto, jolla voit lähettää sopimuksen käyttämällä puhelintodennusmenetelmää.

Voit yhdistää tiedot suoraan lomakekenttiin seuraavilla menetelmillä:

• Kirjastomallin käyttäminen:
  
  Jos käytät kirjastomallin tunnusta FileInfo-parametrin alla, varmista, että syötät seuraavassa osiossa täsmälleen saman kentän nimen ja siihen liittyvät tiedot:

• Tekstitunnisteiden käyttäminen asiakirjassa, joka on ladattu palvelimelle tilapäisenä:
  
  Jos lataat palvelimelle teksitunnisteita sisältävän asiakirjan tilapäisenä asiakirjana, varmista, että syötät seuraavassa osiossa kentän nimen ja siihen liittyvät tiedot täsmälleen samassa muodossa: 

Kuinka voit lähettää API:n avulla sopimuksen, jossa erityisillä lomakekentillä (mergefield) on valmiiksi täytettyjä arvoja?

Tämän kutsun edellytyksenä on suorittaa ensin "Transient Upload” -vaihe ja hankkia "transientDocumentId"-tunnus (käyttämällä seuraavaa: secure.na1.echosign.com/public/docs/restapi/v5#!/transientDocuments/createTransientDocument) käytettäväksi tässä.

• Tämä kutsu sisältää mergeFieldInfo-osion, jossa on annettu tiettyjen lomakekenttien oletusarvot.
• Tämä esitäyttää API-kutsussa tiedot toisesta järjestelmästä.
• Nämä sopimuksen kentät ovat joko muokattavia tai vain luku -muotoisia.

Edellytykset:

1. Tilapäisen dokumentin tunnus
2. Kenttien nimet ja niiden arvot

Esimerkki pyyntökutsusta:

Kun suoritat post /megaSigns/{megaSignId}/views -menetelmän, näet virheen: ”Pyydetty menetelmä ei ole käytettävissä nykyisessä tilassa olevaa resurssia varten.”

Alla olevassa pyynnön koodissa näytetään virhe, jos parametrin arvo on väärä:

{
  "name": " "
}

Virhe ilmenee, jos esimerkiksi MegaSign-sopimuksen tilana on jo "IN_PROCESS", mutta syötät arvoksi "AUTHORING". Varmista, että annettu arvo vastaa sopimuksen nykyistä tilaa.

Kun suoritat put /megaSigns/{megaSignId}/state -menetelmän, näet virheen ”MegaSign-peruutustiedoille ei ole annettu arvoa.”

Virhe ilmenee, kun pyyntökoodista puuttuu parametri: 

 "megaSignCancellationInfo": {
    "comment": "",
    "notifyOthers": false
  }

Käytä Minimal Schema -parametrin sijaan Complete Model Schema -parametria ja syötä pyynnön koko koodi API-kutsun suorittamista varten. 

Jos haluat muuttaa MegaSign-sopimuksen tilaa, käytä put /megaSigns/{megaSignId}/state -menetelmää ja suorita seuraavat toimet:

1. Siirry REST API V6:n dokumentaatioon ja valitse metodi
   put /megaSigns/{megaSignId}/state.
2. Anna valtuutusarvo sekä If-Match ja megasignID.
   • Käytä megasignID-parametrin hakemiseen get /megaSigns -menetelmää.
   • Käytä If-Match-parametrin hakemiseen get /megaSigns/{megaSignId} -menetelmää ja etsi otsikon alle ”Etag”
3. {
     "state": "CANCELED",
     "megaSignCancellationInfo": {
      "comment": "cancel",
      "notifyOthers": false
     }
   } 

Webhookin rekisteröinnin onnistumisen varmistamiseksi webhookin URL-osoite vastaa tähän vahvistuspyyntöön 2XX-vastauskoodilla. Tämän lisäksi se pystyy lähettämään saman asiakastunnuksen arvon takaisin kahdella tavalla:

1. Vastauksen otsikossa X-AdobeSign-ClientId. Se on sama otsikko kuin mikä hyväksytään pyynnössä, ja se toistetaan vastauksessa.
2. JSON-vastauksen tekstiosassa avaimella X-AdobeSign-ClientId, jonka arvo on sama kuin pyynnössä lähetetty asiakastunnus.

Acrobat Sign vastaanottaa 2xx-vastauksen X-AdobeSign-ClientId-tunnuksella.. Käyttäjä voi tarkistaa, onko se määritetty webhookissa oikein vai ei.

Webhookin URL-osoite ei vastaa odotetulla tavalla. Jokaisessa Acrobat Signin lähettämässä viesti-ilmoituksessa URL-osoite vastaa 2XX-tilakoodia, ja pyyntöjen otsikoissa lähetettyä asiakastunnusta (X-AdobeSign-ClientId) käytetään vastausten otsikoissa. 

Näet kaikki tiedot seuraavasta linkistä:
https://developer.adobe.com/acrobat-sign/docs/overview/developer_guide/#!adobedocs/adobe-sign/master/webhooks/webhook_events.md

Kun URL-osoite ei noudata tätä protokollaa, Acrobat Sign katsoo, että se ei kuitannut pyyntöä, ja yrittää aikatauluttaa toiminnon uudelleen luotettavan käytännön mukaisesti.

Jos webhook ei vastaa ja uudelleenyritysten maksimiaika tai yritysten maksimiaikaväli ylittyy, webhook poistetaan käytöstä.

  Twitter™- ja Facebook-viestit eivät kuulu Creative Commons -ehtojen piiriin.

Jos haluat muuttaa dokumenttia, joka on jo lähetetty allekirjoitettavaksi, käytä PUT /agreements/{agreementId} -menetelmää, jolla voit päivittää nykyisen sopimuksen. Anna tilapäinen tunnus yhdessä sopimustunnuksen kanssa seuraavassa pyyntökoodissa:

Seuraavassa on annettu ohjeet, joilla voit päivittää AUTHORING-tilan IN_PROCESS-tilaksi Put /agreements/{agreementId}/state -menetelmällä:

Ei.

Nykyisessä REST API:ssä ei ole allekirjoitetun kopion lähetysmenetelmää.

Lähettäjän on lähetettävä allekirjoitettu kopio Hallinta-sivulta.

POISTA /agreements/ID salli kätkeä sopimuksen Hallinta-sivulta.

Adobella on uusi API PUT /agreements/ID/me/visibility, jolla voi hallita sopimuksen näkyvyyttä (GET /agreements -metodilla). DELETE /agreements/ID -metodin tarjoaman toiminnon lisäksi uusi näkyvyyden päätepiste antaa käyttäjälle mahdollisuuden myös piilotustoiminnon kumoamiseen eli sopimuksen näyttämiseen. 

Voit myös seurata alla olevia yksityskohtaisia ohjeita:

1. Siirry get /agreements -metodiin ja hae sopimustunnus.
2. Napsauta put /agreements/{agreementId}/me/visibility -metodia ja anna esimerkkinä alla oleva pyyntö:
   {
     "visibility": "HIDE"
   }
   Sopimustunnus piilotetaan get /libraryDocuments -metodissa, joten se näkyy edelleen Hallinta-välilehden käyttöliittymässä.

Saat seuraavan vastauksen, jos DELETE/agreements-toimintoa ei ole otettu käyttöön:

 "code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",

  "message": ”Toiminto edellyttää joidenkin tilin asetusten ottamista käyttöön. Ota yhteyttä Acrobat Sign -tiimiin asetusten ottamiseksi käyttöön."

Ota selvää, miten voit ladata allekirjoitetun dokumentin ja valvontaraportin sekä tukidokumentaation Acrobat Sign REST API:n kautta sen sijaan, että tekisit erillisen kutsun ladataksesi valvontaraportin seuraavalla menetelmällä.

GET /agreements/{agreementId}/auditTrail

Jos haluat ladata dokumentteja eränä, vain dokumenttien vientityökalu on käytettävissä, ja API:llä voit ladata dokumentteja vain yksi kerrallaan. API-menetelmä on seuraava:

https://secure.na1.adobesign.com/public/docs/restapi/v5#!/agreements/getCombinedDocument

Adobella on uusi API PUT/libraryDocuments/ID/me/visibility, jolla voi hallita sopimuksen näkyvyyttä (GET /agreements -menetelmää käytettäessä). DELETE /agreements/ID -metodin tarjoaman toiminnon lisäksi uusi näkyvyyden päätepiste antaa käyttäjälle mahdollisuuden myös piilotustoiminnon kumoamiseen eli sopimuksen näyttämiseen

Noudata alla olevia yksityiskohtaisia vaiheita:

1. Siirry get /libraryDocuments -metodiin ja hae sopimustunnus.
2. Valitse put /libraryDocuments/{libraryDocumentId}/me/visibility ja anna esimerkkinä alla oleva pyyntö:
   {
     "visibility": "HIDE"
   }
   Kirjastotunnus piilotetaan vain get /libraryDocuments -metodissa, joten se näkyy edelleen Hallinta-välilehden käyttöliittymässä.

libraryDocumentID-tunnuksen luominen

Kirjastomallien poistaminen