Käyttöopas Peruuta

Adobe Acrobat Sign API – UKK

 

Adobe Acrobat Sign -opas

Uudet ominaisuudet

  1. Ennakkojulkaisutiedot
  2. Julkaisutiedot
  3. Tärkeät ilmoitukset

Aloita käyttö

  1. Pika-aloitusopas järjestelmänvalvojille
  2. Pika-aloitusopas käyttäjille
  3. Kehittäjille
  4. Video-opetusohjelmakirjasto
  5. UKK

Hallinnoi

  1. Admin Consolen yleiskatsaus
  2. Käyttäjien hallinta
    1. Käyttäjien lisääminen
      1. Lisää käyttäjä
      2. Lisää käyttäjiä eränä
      3. Lisää käyttäjiä hakemistosta
      4. Lisää käyttäjiä MS Azure Active Directorysta
    2. Luo toimintoihin keskittyviä käyttäjiä
      1. Tekniset tilit – API-ohjatut
      2. Palvelutilit – Manuaalisesti ohjatut
    3. Tarkista käyttäjät, joilla on valmisteluvirheitä
    4. Vaihda nimi / sähköpostiosoite
    5. Käyttäjän ryhmäjäsenyyden muokkaaminen
    6. Muokkaa käyttäjän ryhmäjäsenyyttä ryhmäliittymän kautta
    7. Käyttäjän ylentäminen järjestelmänvalvojan rooliin
    8. Käyttäjien tunnistetietotyypit ja SSO
    9. Käyttäjätietojen vaihtaminen
    10. Käyttäjien todentaminen MS Azurella
    11. Käyttäjien todentaminen Google-liitoksella
    12. Tuoteprofiilit
    13. Kirjautumiskokemus 
  3. Tilin/ryhmän asetukset
    1. Asetusten yleiskuvaus
    2. Yleiset asetukset
      1. Tilitaso ja tunnus
      2. Uusi vastaanottajakokemus
      3. Omatoimisen allekirjoittamisen työnkulut
      4. Lähetä eränä
      5. Verkkolomakkeet
      6. Mukautetut lähetystyönkulut
      7. Power Automate -työnkulut
      8. Kirjastoasiakirjat
      9. Kerää lomaketietoja sopimuksilla
      10. Asiakirjan rajoitettu näkyvyys
      11. Liitä allekirjoitetun sopimuksen PDF-kopio 
      12. Sisällytä sähköpostiviestiin linkki
      13. Sisällytä sähköpostiviestiin kuva
      14. Sähköposteihin liitettyjen tiedostojen nimeksi annetaan
      15. Liitä valvontaraportti asiakirjoihin
      16. Yhdistä useita asiakirjoja yhdeksi
      17. Lataa yksittäisiä dokumentteja
      18. Allekirjoitetun asiakirjan lähettäminen
      19. Delegointi tilini käyttäjille
      20. Salli ulkoisten vastaanottajien delegointi
      21. Allekirjoitusvaltuutus
      22. Lähetysvaltuutus
      23. Valtuus lisätä sähköisiä leimoja
      24. Aseta oletusaikavyöhyke
      25. Aseta päivämäärän oletusmuoto
      26. Käyttäjiä useissa ryhmissä (UMG)
        1. Päivitä ottaaksesi käyttöön Käyttäjiä useissa ryhmissä
      27. Ryhmän hallinnoijan käyttöoikeudet
      28. Korvaa vastaanottaja
      29. Valvontaraportti
        1. Yleiskatsaus
        2. Salli todentamaton käyttö tapahtuman vahvistussivulla
        3. Sisällytä muistutukset
        4. Sisällytä näyttötapahtumat
        5. Sisällytä sopimussivujen tai liitteiden määrä
      30. Tapahtuma-alaviite
      31. Tuotteen sisäiset viestit ja ohjeet
      32. Helppokäyttöiset PDF-tiedostot
      33. Uusi sisällönluontitoiminto
      34. Terveydenhuoltoalan asiakas
    3. Tilin asetusten määritys
      1. Lisää logo
      2. Mukauta yrityksen isäntänimeä/URL-osoitetta
      3. Lisää yrityksen nimi
      4. Sopimuksen jälkeinen URL-uudelleenohjaus
    4. Allekirjoitusasetukset
      1. Hyvin muotoillut allekirjoitukset
      2. Anna vastaanottajien allekirjoittaa viimeistään
      3. Allekirjoittajat voivat muuttaa nimeään
      4. Anna vastaanottajien käyttää tallennettua allekirjoitustaan
      5. Mukautetut käyttöehdot ja kuluttajailmoitus
      6. Ohjaa vastaanottajia lomakekentissä
      7. Sopimustyönkulun aloittaminen alusta
      8. Allekirjoittamisesta kieltäytyminen
      9. Salli leimatyönkulut
      10. Vaadi allekirjoittajia antamaan tittelinsä tai yrityksensä
      11. Anna allekirjoittajien tulostaa ja kirjoittaa allekirjoitus
      12. Näytä viestit sähköisesti allekirjoitettaessa
      13. Vaadi allekirjoittajia luomaan allekirjoitus mobiililaitteella
      14. Pyydä allekirjoittajilta IP-osoite
      15. Jätä yrityksen nimi ja titteli pois osallistumisleimoista
    5. Digitaaliset allekirjoitukset
      1. Yleiskatsaus
      2. Lataa ja allekirjoita Acrobatilla
      3. Allekirjoita pilviallekirjoituksilla
      4. Sisällytä tunnistetietojen toimittajien metatiedot
      5. Rajoitetut pilviallekirjoitusten toimittajat
    6. Sähköiset leimat
    7. Digitaaliset tunnistetiedot
      1. Sähköisen identiteetin yhdyskäytävä
      2. Henkilöllisyyden tarkistuskäytäntö
    8. Raportoinnin asetukset
      1. Uusi raporttikokemus
      2. Perinteisen raportin asetukset
    9. Suojausasetukset
      1. Kertakirjautumisasetukset
      2. Muista minut -asetukset
      3. Kirjautumissalasanan käytäntö
      4. Kirjautumissalasanan vahvuus
      5. Verkkoistunnon kesto
      6. PDF-salaustyyppi
      7. API
      8. Käyttäjän ja ryhmän tietoihin pääsy
      9. Sallitut IP-alueet
      10. Tilin jakaminen
      11. Tilin jako-oikeudet
      12. Sopimusten jakamisen ohjausobjektit
      13. Allekirjoittajan henkilöllisyyden varmistus
      14. Sopimuksen allekirjoitussalasana
      15. Asiakirjan salasanan vahvuus
      16. Estä allekirjoittajia maantieteellisen sijainnin mukaan
      17. Puhelintodennus
      18. Tietoon perustuva todennus (KBA)
      19. Salli sivujen purkaminen
      20. Asiakirjalinkin vanhentuminen
      21. Lataa asiakasvarmenne webhookeja/takaisinsoittoja varten
      22. Aikaleima
    10. Lähetysasetukset
      1. Näytä Lähetä-sivu sisäänkirjautumisen jälkeen
      2. Vaadi vastaanottajan nimi lähetettäessä
      3. Lukitse tunnettujen käyttäjien nimiarvot
      4. Sallitut vastaanottajaroolit
      5. Salli sähköiset todistajat
      6. Vastaanottajaryhmät
      7. Kopion saajat
      8. Vastaanottajan sopimuksen käyttöoikeudet
      9. Pakolliset kentät
      10. Asiakirjojen liittäminen
      11. Kenttien yhdistäminen
      12. Muokkaa sopimuksia
      13. Sopimuksen nimi
      14. Kielet
      15. Yksityisviestit
      16. Sallitut allekirjoitustyypit
      17. Muistutukset
      18. Allekirjoitetun asiakirjan salasanasuojaus
      19. Lähetä sopimusilmoitus, lähetystapana
      20. Allekirjoittajan tunnistusvaihtoehdot
        1. Yleiskatsaus
        2. Allekirjoitussalasana
        3. Kertasalasana sähköpostitse
        4. Acrobat Sign -todennus
        5. Puhelintodennus
        6. Pilvipohjainen digitaalinen allekirjoitus
        7. Tietoon perustuva todennus
        8. Henkilöllisyystodistus
        9. Allekirjoittajan henkilötietoraportit
      21. Sisällön suojaus
      22. Ota Notarize-tapahtumat käyttöön
      23. Asiakirjan voimassaolo
      24. Esikatsele, sijoita allekirjoitukset ja lisää kentät
      25. Allekirjoitusjärjestys
      26. Liquid Mode
      27. Mukautetun työnkulun säätimet
      28. Sähköisen allekirjoituksen sivun latausasetukset
      29. Allekirjoituksen jälkeinen URL-vahvistuksen uudelleenohjaus
    11. Viestimallit
    12. Biofarmakologiset asetukset
      1. Yleiskatsaus
      2. Edellytä henkilöllisyyden todennusta
      3. Allekirjoittamisen syyt
    13. Työnkulkujen integraatio
    14. Notarisointiasetukset
    15. Maksujen integrointi
    16. Allekirjoittajan viestit
    17. SAML-asetukset
      1. SAML-kokoonpano
      2. Asenna Microsoft Active Directoryn liitospalvelu
      3. Asenna Okta
      4. Asenna OneLogin
      5. Asenna Oracle Identity -liitos
    18. Tietojen hallinnointi
    19. Aikaleima-asetukset
    20. Ulkoinen arkisto
    21. Tilin kielet
    22. Sähköpostin asetukset
      1. Sähköpostin ylä- ja alatunnistekuvat
      2. Salli yksittäisten käyttäjien sähköpostin alatunnisteet
      3. Mukauta Pyydetty allekirjoitusta -sähköpostiviestiä
      4. Mukauta Vastaanottaja- ja Piilokopio-kenttiä
      5. Ota linkittömät ilmoitukset käyttöön
      6. Sähköpostimallien mukauttaminen
    23. Siirtyminen echosign.comista adobesign.comiin
    24. Vastaanottajien vaihtoehtojen määrittäminen
  4. Sääntelyvaatimuksia koskevat ohjeet
    1. Helppokäyttöisyys
      1. Helppokäyttöisyyden vaatimustenmukaisuus
      2. Esteettömien lomakkeiden luominen Acrobat-tietokonesovelluksella
      3. Esteettömien AcroForms-lomakkeiden luominen
    2. HIPAA
    3. GDPR
      1. GDPR:n yleiskatsaus
      2. Käyttäjän muokkaaminen
      3. Käyttäjän sopimusten muokkaaminen
    4. 21 CFR osa 11 ja EudraLex liite 11
      1. 21 CRF osa 11 validointipaketti
      2. 21 CFR ja EudraLex Liite 11:n käsikirja
      3. Jaettujen vastuiden analysointi
    5. Terveydenhuollon asiakkaat
    6. IVES-tuki
    7. Sopimusten tallentaminen säilöön
    8. EU:ta ja Yhdistynyttä kuningaskuntaa koskevat huomiot
      1. EU:n ja Yhdistyneen kuningaskunnan rajat ylittävät tapahtumat ja eIDAS
      2. Sähköisesti allekirjoitettujen asiakirjojen HMLR-vaatimukset
      3. Brexitin vaikutus Yhdistyneen kuningaskunnan sähköisiä allekirjoituksia koskeviin lakeihin
  5. Lataa sopimukset eränä
  6. Toimialueen varaus 
  7. Väärinkäytöksistä ilmoittamiseen liittyvät linkit

Sopimusten lähetys, allekirjoitus ja hallinta

  1. Vastaanottajavaihtoehdot
    1. Sähköpostimuistutuksen peruuttaminen
    2. Sähköisen allekirjoitussivun asetukset
      1. Yleiskatsaus sähköiseen allekirjoitussivuun
      2. Avaa ja lue sopimus ilman kenttiä
      3. Kieltäydy allekirjoittamasta sopimusta
      4. Delegoi allekirjoituksen myöntäjä
      5. Aloita sopimus alusta
      6. Lataa PDF-versio sopimuksesta
      7. Tarkastele sopimuksen historiatietoja
      8. Tarkastele sopimusviestejä
      9. Sähköisestä allekirjoituksesta käsin kirjoitetuksi allekirjoitukseksi muuntaminen
      10. Käsin kirjoitetun allekirjoituksen muuntaminen sähköiseksi allekirjoitukseksi 
      11. Siirry lomakekentillä
      12. Tyhjennä lomakekenttien tiedot
      13. Allekirjoita sivun suurennus ja siirtyminen sähköisesti
      14. Sopimuksen työkaluissa ja tiedoissa käytettävän kielen vaihtaminen
      15. Tarkista lakisääteiset ilmoitukset
      16. Muuta Acrobat Signin evästeasetuksia
  2. Lähetä sopimuksia
    1. Lähetä-sivun yleiskatsaus
    2. Sopimuksen lähettäminen vain itselleen
    3. Sopimuksen lähettäminen muille
    4. Kirjoitetut allekirjoitukset
    5. Vastaanottajien allekirjoitusjärjestys
    6. Lähetä eränä
      1. Erälähetys-toiminnon yleiskatsaus
      2. Erälähetys – päämallin määrittäminen
      3. Erälähetys – CSV-tiedoston määrittäminen
      4. Peruuta erälähetystapahtuma
      5. Lisää muistutuksia erälähetykseen
      6. Erälähetyksen raportointi
  3. Kenttien lisääminen asiakirjoihin
    1. Sovelluksen sisällönluontiympäristö
      1. Automaattinen kenttien tunnistus
      2. Vedä ja pudota kenttiä sisällönluontiympäristössä
      3. Lomakekenttien määritys vastaanottajille
      4. Esitäyttö-rooli
      5. Lisää kenttiä uudelleenkäytettävällä kenttämallilla
      6. Kenttien siirtäminen uuteen kirjastomalliin
      7. Päivitetty sisällönluontiympäristö sopimuksia lähetettäessä
    2. Lomakkeiden ja tekstitunnisteiden luominen
    3. Lomakkeiden luominen Acrobatilla (AcroForms)
      1. AcroFormin luonti
      2. Esteettömien PDF-tiedostojen luominen
    4. Kentät
      1. Kenttätyypit
        1. Yleiset kenttätyypit
        2. Riville sovitetut kuvat
        3. Leiman kuvat
      2. Kentän sisällön ulkoasu
      3. Kenttien vahvistukset
      4. Peitettyjen kenttien arvot
      5. Näyttö-/piilotusehtojen asettaminen
      6. Lasketut kentät 
    5. Sisällönluontiin liittyvät usein kysytyt kysymykset
  4. Allekirjoita sopimuksia
    1. Allekirjoita sinulle lähetettyjä sopimuksia
    2. Täytä ja allekirjoita
    3. Omatoiminen allekirjoittaminen
  5. Sopimusten hallinta
    1. Hallinta-sivun yleiskatsaus
    2. Sopimusten delegointi
    3. Vastaanottajien korvaaminen
    4. Asiakirjan näkyvyyden rajoitus 
    5. Sopimuksen peruuttaminen 
    6. Luo uusia muistutuksia
    7. Tarkista muistutukset
    8. Muistutuksen peruuttaminen
    9. Power Automate -työnkulkujen käyttäminen
    10. Lisää toimintoja...
      1. Miten haku toimii
      2. Sopimuksen tarkasteleminen
      3. Luo malli sopimuksesta
      4. Piilota/näytä sopimukset näkymästä
      5. Allekirjoitetun kopion lataaminen
      6. Lähetetyn sopimuksen tiedostojen ja kenttien muokkaaminen
      7. Muokkaa vastaanottajan todennusmenetelmää
      8. Vanhentumispäivän lisääminen tai muokkaaminen
      9. Huomautuksen lisäys sopimukseen
      10. Yksittäisen sopimuksen jakaminen
      11. Sopimuksen jaon poistaminen
      12. Yksittäisen sopimuksen lataaminen
      13. Sopimuksen yksittäisten tiedostojen lataaminen
      14. Sopimuksen valvontaraportin lataaminen
      15. Sopimuksen kenttäsisällön lataaminen
  6. Valvontaraportti
  7. Raportointi ja tietojen viennit
    1. Yleiskatsaus
    2. Myönnä käyttäjille oikeudet raportointiin
    3. Raporttikaaviot
      1. Luo uusi raportti
      2. Sopimusraportit
      3. Tapahtumaraportit
      4. Asetusten toimintaraportti
      5. Muokkaa raporttia
    4. Tietojen viennit 
      1. Uuden tietojen viennin luonti
      2. Verkkolomakkeen tietojen vienti
      3. Muokkaa tietojen vientiä
      4. Tietojen viennin sisällön päivittäminen
      5. Tietojen viennin lataaminen
    5. Kaavion/viennin nimeäminen uudelleen
    6. Raportin/viennin monistaminen
    7. Raportin/viennin ajoittaminen
    8. Raportin/viennin poistaminen
    9. Tarkista tapahtuman käyttö

Edistyneet sopimustoiminnot ja -työnkulut

  1. Verkkolomakkeet
    1. Luo verkkolomake
    2. Muokkaa verkkolomaketta
    3. Poista verkkolomake käytöstä / ota verkkolomake käyttöön
    4. Verkkolomakkeen piilottaminen/näyttäminen
    5. Etsi URL-osoite tai komentosarjakoodi 
    6. Verkkolomakekenttien esitäyttö URL-parametreilla
    7. Verkkolomakkeen tallentaminen myöhemmin täytettäväksi
    8. Muuta verkkolomakkeen kokoa
  2. Uudelleenkäytettävät mallit (Kirjastomallit) 
    1. Yhdysvaltain valtionhallinnon lomakkeet Acrobat Sign -kirjastossa
    2. Kirjastomallin luonti
    3. Kirjastomallin nimen muuttaminen
    4. Kirjastomallin tyypin muuttaminen
    5. Kirjastomallin käyttöoikeustason muuttaminen
    6. Jaetun mallin kopiointi, muokkaus ja tallennus
    7. Lataa kirjastomallin koostekenttätiedot
  3. Siirrä verkkolomakkeiden ja kirjastomallien omistus
  4. Power Automate -työnkulut 
    1. Power Automate -integraation ja siihen sisältyvien oikeuksien yleiskatsaus
    2. Ota Power Automate -integraatio käyttöön
    3. Hallinta-sivun tilanteenmukaiset toiminnot
    4. Seuraa Power Automaten käyttöä
    5. Uuden työnkulun luominen (esimerkkejä)
    6. Työnkulkuihin käytettävät käynnistimet
    7. Työnkulkujen tuominen Acrobat Signin ulkopuolelta
    8. Työnkulkujen hallinta
    9. Työnkulkujen muokkaus
    10. Työnkulkujen jako
    11. Työnkulkujen käytöstäpoisto tai käyttöönotto
    12. Työnkulkujen poisto
    13. Hyödyllisiä malleja
      1. Vain järjestelmänvalvoja
        1. Kaikkien valmiiden asiakirjojen tallentaminen SharePointiin
        2. Kaikkien valmiiden asiakirjojen tallentaminen OneDrive for Businessiin
        3. Kaikkien valmiiden asiakirjojen tallentaminen Google Driveen
        4. Kaikkien valmiiden asiakirjojen tallentaminen DropBoxiin
        5. Kaikkien valmiiden asiakirjojen tallentaminen Boxiin
      2. Sopimuksen arkistointi
        1. Valmiiden asiakirjojen tallentaminen SharePointiin
        2. Valmiiden asiakirjojen tallentaminen OneDrive for Businessiin
        3. Valmiiden asiakirjojen tallentaminen Google Driveen
        4. Valmiiden asiakirjojen tallentaminen DropBoxiin
        5. Valmiiden asiakirjojen tallentaminen Boxiin
      3. Verkkolomakesopimusten arkistointi
        1. Valmiiden verkkolomakeasiakirjojen tallentaminen SharePoint-kirjastoon
        2. Valmiiden verkkolomakeasiakirjojen tallentaminen OneDrive for Businessiin
        3. Valmiiden asiakirjojen tallentaminen Google Driveen
        4. Valmiiden verkkolomakeasiakirjojen tallentaminen Boxiin
      4. Sopimustietojen poiminta
        1. Lomakekenttätietojen poimiminen allekirjoitetusta asiakirjasta ja Excel-taulukon päivittäminen
      5. Sopimusilmoitukset
        1. Lähetä sopimuksen sisällön ja allekirjoitetun sopimuksen sisältäviä mukautettuja sähköposti-ilmoituksia
        2. Vastaanota Adobe Acrobat Sign -ilmoituksia Teams-kanavalla
        3. Vastaanota Adobe Acrobat Sign -ilmoituksia Slackissa
        4. Vastaanota Adobe Acrobat Sign -ilmoituksia Webexissä
      6. Sopimuksen luonti
        1. Luo asiakirja Power App -lomakkeesta ja Word-mallista, lähetä allekirjoitettavaksi
        2. Luo sopimus OneDrivessa olevasta Word-mallista ja hanki allekirjoitus
        3. Luo sopimus valitulle Excel-riville, lähetä tarkistettavaksi ja allekirjoitettavaksi
  5. Mukautetut lähetystyönkulut
    1. Mukautetun lähetystyönkulun yleiskatsaus
    2. Uuden lähetystyönkulun luominen
    3. Lähetystyönkulun muokkaaminen
    4. Poista lähetystyönkulun aktivointi tai aktivoi se uudelleen
    5. Sopimuksen lähetys Lähetä työnkulku -toiminnolla
  6. Käyttäjien ja sopimusten jakaminen
    1. Käyttäjän jakaminen
    2. Sopimuksien jakaminen

Muihin tuotteisiin integrointi

  1.  Acrobat Sign -integraatioiden yleiskatsaus 
  2. Acrobat Sign for Salesforce
  3. Acrobat Sign for Microsoft
    1. Acrobat Sign for Microsoft 365
    2. Acrobat Sign for Outlook
    3. Acrobat Sign for Word/PowerPoint
    4. Acrobat Sign for Teams
    5. Acrobat Sign for Microsoft PowerApps and Power Automate
    6. Acrobat Sign Connector for Microsoft Search
    7. Acrobat Sign for Microsoft Dynamics 
    8. Acrobat Sign for Microsoft SharePoint 
  4. Muut integraatiot
    1. Acrobat Sign for ServiceNow
    2. Acrobat Sign for HR ServiceNow
    3. Acrobat Sign for SAP SuccessFactors
    4. Acrobat Sign for Workday
    5. Acrobat Sign for NetSuite
    6. Acrobat Sign for VeevaVault
    7. Acrobat Sign for Coupa BSM Suite
  5. Kumppanin hallitsemat integraatiot
  6. Mistä hankin integrointiavaimen

Acrobat Sign Developer

  1. REST-ohjelmointirajapinnat 
    1. Menetelmäopas
    2. SDK-/Kehittäjän opas
    3. API:in liittyvät usein kysytyt kysymykset
  2. Webhookit 
    1. Webkoukun yleiskatsaus
    2. Uuden webhookin määrittäminen
    3. Tarkastele tai muokkaa webhookia
    4. Poista webhookin aktivointi tai aktivoi se uudelleen
    5. Webhookin poistaminen
    6. Kaksisuuntaiset SSL-varmenteet
    7. Webhookit ohjelmointirajapinnassa

Tuotetuki ja vianetsintä

  1. Asiakastukiresurssit 
  2. Enterprise Customer Success -resurssit 

API:n käyttöoikeus on varattu yksinomaan konserni- ja kehittäjätason tileille.

Linkit keskeiseen dokumentaatioon

Huomautus:

Vanhojen SOAP API -rajapintojen tuki on päättynyt toukokuussa 2021.

Kaikkien SOAP APIa käyttävien asiakkaiden pitäisi siirtyä REST APIin mahdollisimman pian.

Siirry sisäänkirjautumisen jälkeen kohtaan Tili > Acrobat Sign API > API-tiedot > Rest APIt ja opas.


Yleiset käsitteet

Dokumenttia ei voi luoda tarkastelemalla sivua verkkokäyttöliittymässä, vetämällä ja pudottamalla tai määrittämällä allekirjoittajan rooleja transientDocumentId:llä API:n kautta.

transientDocuments-kutsu palauttaa transientDocumentID:n, joka on voimassa 7 päivää.  Voit käyttää sitä vain muihin API-kutsuihin. Se on tallennettu API-palvelimelle, ja sille on määritetty tämä tunnus. Lähetä tiedosto ja viittaa sitten sen tunnukseen seuraavissa API-kutsuissa.

Dokumenttia ei voi lähettää suoraan sopimukseen REST API:llä.

Luo ensin REST-vaatimuksen mukaisesti tilapäinen dokumentti ja käytä sitten tätä tunnusta sopimus-, widgetti- tai kirjastomenetelmässä lähdetiedostona.

Tilapäinen dokumentti on raaka lähdetiedosto, kuten PDF, doc tai docx, joka on lähetetty Adoben palvelimille. Se on siis kätevä tapa siirtää perusdokumentti API-palvelimille ja tilapäinen dokumentti verkkoon.

Kyllä, voit lähettää sopimuksia käyttämällä v6:n työnkulkuja ja API-kutsua POST /agreements. Hyväksy API-kutsun workflowId-parametri.

Saat työnkulun workflowId-parametrin GET /workflows -kutsulla.

  1. Kirjaudu Adobe Signiin järjestelmänvalvojana.

  2. Siirry kohtaan Tili > Adobe Sign API > API:n pyyntöloki.

    API-lokit

  1.  Kirjaudu Adobe Signiin järjestelmänvalvojana.

  2. Siirry kohtaan Tili > Adobe Sign API > API:n tiedot.

  3. Napsauta REST API Samples -linkkiä.

    Huomautus:

    Jos haluat ladata JavaScript SDK:n, katso https://github.com/adobe-sign/AdobeSignJsSdk.

Versiosta v6 alkaen parametri sendTroughWeb ei enää ole käytettävissä. Se korvataan state-parametrilla. Se viittaa sopimuksen tilaan. Tila-kenttä on käytettävissä vain POST-kutsuissa. Sitä ei koskaan palauteta GET /agreements/{ID} -kutsuissa, ja se ohitetaan, jos se annetaan PUT /agreements/{ID} -kutsussa. Sopimuksen kulloinenkin tila voidaan hakea GET /agreements/ID -kutsulla.

state(string) = ['AUTHORING' or 'DRAFT' or 'IN_PROCESS'].

AUTHORING antaa käyttäjälle mahdollisuuden laatia sopimuksen asiakirjat ennen niiden lähettämistä. Sisällönluontitoiminnolla tarkoitetaan tässä lomakekenttien luontia, muokkausta tai lisäämistä yhdessä niiden kokoonpanojen kanssa (esim. vastuuhenkilö, ehdot ja tietotyyppi) sopimusdokumentteihin. Kun dokumentti on lähetetty Sisällönluonti-tilassa, dokumentti näkyy Adobe Signin Hallinta-välilehden Luonnos-osiossa.

DRAFT on lopulliseksi aiotun resurssin tilapäinen tai primitiivinen tila, joka voidaan päivittää asteittain lopullisen resurssin luomiseksi, eikä se näy Adobe Signin Hallinta-välilehden Luonnos-osiossa. Luonnos-tilassa Osallistuja-joukon tietoja ei tarvita, ja ne voidaan määrittää myöhemmin, kun luonnoksen viimeistelemiseen käytetään PUT /agreements/agreementId -kutsua. Tämä vaihe voidaan toistaa monta kertaa, kunnes sinulla on kaikki tarvittavat tiedot sopimuksen luontiin.

IN_PROCESS muuttaa sopimuksen tilaksi Allekirjoitettavana, ja se näkyy Adobe Signin Hallinta-välilehden Allekirjoitettavana-osiossa.

sendThroughWebin avulla voit lähettää sopimuksen vuorovaikutteisesti. v5 POST /agreements -pyynnön options-kentän parametrien avulla käyttäjä voi määrittää tämän vuorovaikutteisen näkymän (Lähetä-sivun). Kaikki nämä sivun määritysparametrit, kuten fileUploadOptions, siirretään POST agreements/ID/views API:hin.

Voit siis suorittaa sendThroughWeb-toiminnon luomalla sopimuksen SISÄLLÖNLUONTI-tilassa POST /agreements API:n kautta. Voit pyytää haluamasi kokoonpanon seuraavan sivun URL-osoitteen POST agreements/ID/views API -kutsulla.

Suorita seuraavat vaiheet:

1. Siirry REST API V6:n dokumentaatioon ja valitse POST/agreements-menetelmä.
2. Käytä seuraavaa pyynnön koodia:

{

  "fileInfos": [

    {

      "transientDocumentId": "***************************"

    }

  ],

  "name": "test",

  "participantSetsInfo": [

    {

      "memberInfos": [

        {

          "email": "abc@gmail.com"

        }

      ],

      "order": 1,

      "role": "SIGNER"

    }

  ],

  "signatureType": "ESIGN",

  "state": "AUTHORING"

}

 

3. Käytä nyt post /agreements/{agreementId}/views -menetelmää alla olevalla pyyntökoodilla:

 

{

  "name": "AUTHORING"

}

Vastauskoodi sisältää sisällönluontikenttien URL-osoitteen.

Vastakutsun URL-osoite voidaan määrittää seuraavilla tavoilla:

  • Määritä vastakutsun URL-osoite käyttämällä alla olevaa parametria tarpeen mukaan:

    "callbackInfo": "",
  • Ota yhteyttä Adobe Sign -tukeen, jos haluat asettaa oletusarvoisen vastakutsun URL-osoitteen koko tilille.

SOAP UI:ssä (SmartBear) ilmenee seuraava SSL-yhteysvirhe, kun teet API-kutsun. Tämä virhe ilmenee yleensä silloin, jos käytät vanhentunutta SSL- tai TLS-protokollaa, joka on vanhempi kuin TLS1.2.

ERROR: Exception in request: javax.net.ssl.SSLException: Received fatal alert: protocol_version
ERROR: An error occurred [Received fatal alert: protocol_version], see error log for details

  1. Lisää (-Dsoapui.https.protocols=SSLv3,TLSv1.2) Bin-kansiossa olevaan VMOPTIONS-tiedostoon.

  2. Siirry polkuun C:\Program Files\SmartBear\SoapUI-5.2.1\bin. (Se vaihtelee sen mukaan, minne SOAP UI on asennettu. Se voi olla polussa C:\Program Files (x86).)

  3. Ota VMOPTIONS-tiedostossa täydet luku- ja kirjoitusoikeudet käyttöön.

    VMOPTIONS

  4. Napsauta hiiren kakkospainikkeella VMOPTIONS-tiedosto > Ominaisuudet > Suojaus-välilehti > valitse käyttäjä > napsauta Muokkaa. (Muokkaa-painikkeeseen ilmestyy Käytönvalvonta-kuvake) > Valitse kaikki valintaruudut ja napsauta OK.

  5. Toista tämä järjestelmänvalvojille, järjestelmille ja kaikille sovelluspaketeille.

  6. Avaa tiedosto Muistiossa.

  7. Lisää protokolla ”-Dsoapui.https.protocols=SSLv3,TLSv1.2” loppuun ja tallenna muutokset.

  8. Sulje SOAP UI ja käynnistä se uudelleen. Se toimii ilman SSL-virheitä, kun teet API-kutsun. (Tarkista toimivuus testi-ping-kutsulla.)

Voit luoda asiakastunnuksen ja asiakasohjelman salasanan Adobe Sign -sovelluksessa toimimalla seuraavien ohjeiden mukaan:

  1. Kirjaudu Adobe Sign -tiliin.

  2. Siirry kohtaan Tili > Adobe Sign API > API-sovellukset.

    Fnord.

  3. Luo sovellus napsauttamalla pluskuvaketta (+).

    Fnord.

  4. Anna nimi ja näyttönimi.

  5. Valitse Toimialue-kohdassa ASIAKAS ja valitse sitten Tallenna.

    Fnord.

  6. Korosta sovellus napsauttamalla sitä kerran.

  7. Valitse Määritä OAuth sovellukselle.

    Fnord.

  8. Anna uudelleenohjauksen URI-tunnus.

  9. Ota tarvittavat käyttöalueet käyttöön valitsemalla niitä vastaavat valintaruudut ja sitten Tallenna.

  1. Siirry kohtaan Tili > Adobe Sign API > API:n tiedot.

  2. Napsauta Integrointiavain-linkkiä.

    Siirry Integrointiavain-kohtaan.

    Huomautus:

    Jos et näe Integrointiavain-linkkiä, ota yhteyttä Success Manageriin ja pyydä häntä ottamaan tilisi käyttöön.

    • Anna avaimen nimeksi intuitiivinen arvo.
    • Valitse sovelluksen toiminnon vaatimat käyttöalueet.
    • Kun avain on kokonaan määritetty, valitse Tallenna.
    Luo integrointiavain -käyttöliittymä

  3. Kun avain on tallennettu, se löytyy kohdasta Tili > Henkilökohtaiset valinnat > Käyttöoikeustunnukset.

    Avaimen nimi ja kaikki käytössä olevat käyttöalueet luetellaan.  

    Tuo toimintolinkit näkyviin napsauttamalla avaimen kuvausta kerran:

    • Integrointiavain – Tämä linkki tarjoaa literaaliavaimen.
    • Kumoa – Tämä kumoaa ja poistaa käyttöoikeustunnuksen lopullisesti.
    Käyttöoikeustunnukset – Integrointiavain

  1. Kirjaudu Adobe Sign -tiliin.

  2. Siirry kohtaan Tili > Adobe Sign API > API-sovellukset.

  3. Luo sovellus napsauttamalla pluskuvaketta (+).

    Postman1

  4. Valitse Määritä OAuth sovellukselle.

    Fnord.

  5. Luo valtuutuskoodi käyttämällä seuraavaa linkkiä. Asiakastunnuksen, uudelleenohjauksen URL-tunnuksen ja käyttöalueiden on oltava samat kuin seuraavassa URL-osoitteessa, kuten sovelluksessa on valittu. (Vältä välilyöntiä seuraavassa URL-osoitteessa, ja pirstale, kuten NA1, on sen Adobe Sign -tilin mukainen, johon se kuuluu.)

    https://secure.na1.echosign.com/public/oauth?redirect_uri=https://www.google.co.in&response_type=code&client_id=CBJCHBCAABAAo9FZgq31_5BVG_kcIXEe6gNtn-R-gdNe&scope=user_login:self+agreement_send:account

  6. Jos kutsu onnistuu, valitse valtuutuskoodi osoiteriviltä.

    Fnord.

  7. Lataa ja asenna Postman linkistä https://www.getpostman.com/apps.

  8. Kun se on ladattu ja asennettu, luo VIESTI napsauttamalla UUSI.

  9. Anna linkki https://secure.na1.echosign.com/oauth/token sen mukaan, mihin Adobe Sign -tilisi kuuluu.

  10. Kirjoita Headers-kohtaan Content-Type-arvoksi application/x-www-form-urlencoded.

  11. Varmista, että x-www-form-urlencoded on valittu Body-kohdasta, anna alla olevat parametrit ja niiden arvot Adobe Sign -tilillä luomastasi sovelluksesta ja valitse SEND.

    Fnord.

  12. Jos kaikki tiedot ovat oikein, vastauksessa palautetaan käyttöoikeustunnus ja päivitystunnus.

    Fnord.

Noudata OAuth-prosessin aikana seuraavia ohjeita:

1. Määritä asiakastunnus ja uudelleenohjauksen URI-tunnus oikein.
2. Valtuutuksen URL-osoitteessa annettujen käyttöalueiden on vastattava täydellisesti Adobe Sign -sovelluksessa annettuja käyttöalueita.
3. Käytä oikeaa pirstaletta (na1, na2, au1, eu1, jp1) määritettävän tilin mukaisesti.
4. Poista mahdolliset välilyönnit valtuutuksen URL-osoitteesta (jos niitä on).
5. Tarkista valtuutuksen URL-osoitteen syntaksi:

https://secure.na1.echosign.com/public/oauth?redirect_uri=https://secure.na1.echosign.com/public/oauthDemo&
response_type=code&client_id=9MEJXY4Y4R7L2T&scope=agreement_send

Käyttöoikeustunnukset ovat voimassa vain 3 600 sekuntia (yhden tunnin), minkä jälkeen ne vanhentuvat.

API-pyynnön haltija voi käyttää päivitystunnuksia uusien käyttöoikeustunnusten luontiin tarpeen mukaan.

Webhookeja tuetaan REST API v6:ssa ja uudemmissa.

Jos webhookin vastaanottaja ei vastaa 72 tunnin kuluessa, webhook poistetaan käytöstä, eikä ilmoitusta lähetetä.

Jos kohde-URL-osoite ei jostakin syystä toimi, Adobe Sign asettaa JSONin jonoon ja yrittää suorittaa siirron progressiivisesti 72 tunnin ajan.

Toimittamattomat tapahtumat muutetaan pysyviksi uudelleenyritysjonossa, ja ilmoitukset yritetään toimittaa niiden ilmenemisjärjestyksessä seuraavan 72 tunnin ajan.

Ilmoitusten uudelleentoimituksen strategiana on kaksinkertaistaa yritysten välinen aika, alkaen 1 minuutin aikavälillä, joka kasvaa 12 tunnin välein, ja tuloksena on 15 yritystä 72 tunnin aikana.

 

Jos haluat luoda webhookin suoraan Adobe Sign -käyttöliittymästä, luo ensin webhookin URL-osoite Azure AD -funktiosovelluksista toimimalla seuraavien ohjeiden mukaan:

  1. Kirjaudu Microsoft-tilillä sisään osoitteessa https://portal.azure.com/.

  2. Rekisteröidy Azure AD -tilillä funktiosovellusten käyttöä varten.

    Azure-valikko

  3. Siirry Azure AD:hen, valitse Function Apps ja avaa Functions-valikko napsauttamalla pluskuvaketta (+).

  4. Valitse Webhook+API, määritä kieleksi Javascript ja valitse Create Function.

    Azure API -käyttöliittymä

  5. Korvaa Index.js-tiedosto seuraavalla koodikatkelmalla:

    module.exports = function (context, req) { 
        var clientId = req.headers['x-adobesign-clientid']; 
        // Validate that the incoming ClientID is genuine 
        if (clientId === '************************************') { 
            context.res = { 
                // status: 200, /* Defaults to 200 */ // any 2XX response is acceptable 
                body: { 
                    'xAdobeSignClientId' : clientId, 
                     
                }, 
                headers : { 
                    'Content-Type' : 'application/json' 
                } 
            }; 
        } 
        else { 
            context.res = { 
                status: 400, 
                body: "Opps!! Illegitimate Call identified" 
            }; 
        } 
        context.done(); 
    };
  6. Napsauta oikeassa kulmassa olevaa Test-painiketta ja lisää seuraava otsikko:

    X-AdobeSign-ClientId as ***********************

    API-testi

  7. Valitse Save and Run.

  8. Kun olet saanut 200 OK-vastausta seuraavalla otsikolla, valitse Get function URL

    200 vastausta

  9. Kopioi URL-osoite ja luo toiminto valitsemalla Adobe Sign -käyttöliittymä > Webhookit > napsauta pluskuvaketta (+).

  10. Anna seuraavat tiedot:

    • Nimi: ehdotettava intuitiivinen nimi, jonka muut järjestelmänvalvojat ymmärtävät helposti.
    • Alue: webhookin kattaman verkon laajuus. Tili ja Ryhmä ovat käytettävissä käyttöliittymässä.
      API tukee Tili-, Ryhmä-, Käyttäjä- ja Resurssi-käyttöalueita.
    • Voit määrittää vain yhden käyttöalueen webhookia kohti.
    • URL-osoite: kohde-URL-osoite, johon Adobe Sign on työntämässä JSON-tietoja.
    • Tapahtumat: käynnistin, joka saa Adobe Signin luomaan JSONin ja siirtämään sen URL-osoitteeseen.
      Jokainen tapahtuma luo eri tiedot käynnistystapahtuman perusteella.
      Yhteen webhookiin voi sisältyä useita tapahtumia.
    • Ilmoitusparametrit: ilmoitusparametrit ilmaisevat tapahtuman JSON-tietojen osat, ja voit valita vain tapahtuman tärkeät osat.
    Webhookin käyttöliittymä

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

Sopimusresurssilla tarkoitetaan resurssia, jonka avulla voit luoda sopimuksen, esimerkiksi kirjastodokumentin, widgetin ja sopimuksen, itse.

Jos haluat hakea sopimusresurssitapahtumia, tee ensin pyyntö API:lle, joka luo agreementAssetEvents-objektin asianmukaisilla hakuparametreilla.

Vastaus on tulosten ensimmäinen sivu, joka sisältää hakutunnusparametrin ja seuraavan sivun osoittimen. Voit käyttää sitä uusien sivutulosten hakemiseen, jos niitä on saatavana API:lla, joka hakee agreementAssetEventsin hakutunnuksen perusteella.

  1. Avaa version 5 REST API -dokumentaatio.

  2. Siirry kohtaan post/search/agreementAssetEvents ja luo käyttöoikeustunnus asianmukaisilla käyttöalueilla.

  3. Määritä pyyntökoodissa vaatimusten mukaiset alkamis- ja päättymispäivät:

    { 
      "endDate": "2018-05-22T22:33:33", 
      "startDate": "2017-12-22T22:33:33" 
    }
  4. Valitse Kokeile. Se hakee sopimusten resurssitunnukset, joita voidaan käyttää myös sopimustunnuksina.


Käyttäjien/tilin hallinta

  1. Kirjaudu Adobe Signiin.
  2. Siirry kohtaan Tili > Adobe 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"
    }

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

Adobe One Admin Console käyttää muuta API:tä kuin Adobe Sign API. Saat lisätietoja näistä artikkeleista:

 

Ryhmätunnuksen hakeminen:

  1. Siirry osoitteeseen https://secure.na1.echosign.com/public/docs/restapi/v5.

  2. Valitse Resources and Operations -kohdasta ryhmät.

  3. Valitse GET /groups.

  4. Napsauta oAuth Access-token -painiketta.

  5. Luo käyttöoikeustunnus.

  6. Napsauta Kokeile-painiketta.

    Saat seuraavan vastauksen, joka sisältää tyhmän nimen ja ryhmätunnuksen:

    { 
      "groupInfoList": [ 
        { 
          "groupId": "3AAABLblqZhB4o9EnlvmGB_m8CrG5O6XClTBO7vmojOOexu5r3G95LtEV2Sp7BuhNvQYSvWB7PmmwVPXnhPIiYSuHV98Cerkp", 
          "groupName": "Default Group" 
        }, 
        { 
          "groupId": "3AAABLblqZhC3dPT6za5h7r1-BOEWivCe_OcAVONhcsKa57SL9_iCwGr5v_JED1No5jE20Pcjv0mYH2J-LoY1AcmqS69vRkO7", 
          "groupName": "test" 
        }, 
      ] 
    }

Ryhmän poistaminen:

  1. Valitse DELETE /groups/{groupId}.

  2. Jos haluat luoda käyttöoikeustunnuksen, napsauta oAuth Access-token -painiketta.

  3. Lisää ryhmätunnus, jonka sait vastauksena edelliseen kutsuun ja jonka haluat poistaa groupId-ruudusta.

  4. Valitse Kokeile.

    Saat seuraavan vastauksen, kun ryhmä on poistettu: Ei sisältöä.

Huomautus:

Ryhmää, johon on määritetty käyttäjä, ei voi poistaa. Voit itse asiassa poistaa vain tyhjän ryhmän. Saat seuraavan vastauksen, jos ryhmässä on käyttäjä.


{

  "code": "GROUP_NOT_EMPTY",

  "message": "Ryhmää ei voi poistaa, sillä se ei ole tyhjä."

}


Sopimusten aloittaminen/lähettäminen

Tilapäisen dokumentin luominen

  1. Valitse transientDocuments ja laajenna POST /transientDocuments -menetelmä.

  2. Napsauta OAuth Access-token -painiketta.

    API TransientDocument -menetelmä

    • Ota tapahtuman käyttöalueet käyttöön.
    • Valitse Valtuuta.
    OAuth-alueet

  3. Salli käyttö

    Valitse pyydettäessä Salli käyttö.

  4. Palaat API-menetelmien sivulle. Valtuutus-arvo on nyt täytetty.

    • Kirjoita tiedoston nimi File-Name-kenttään.
    • Napsauta Valitse tiedosto -painiketta ja lähetä sopimusdokumentti.
    • Napsauta Kokeile! -painiketta.
    Kokeile!

  5. Luodaan vastaus.

    transientDocumentID-tunnus löytyy vastauksen tekstiosasta:

    Tilapäisen dokumentin tunnus

Sopimuksen luominen tilapäisen dokumentin avulla

  1. Valitse Sopimukset ja laajenna POST /agreements -menetelmä.

    • Napsauta OAuth Access-token -painiketta.
    • Ota OAuth-alue käyttöön.
    • Valitse Valtuuta.
      • Valitse pyydettäessä Salli käyttö.
  2. Palaat API-menetelmien sivulle. Valtuutus-arvo on nyt täytetty.

    • Kopioi alla oleva komentosarja tekstieditoriin (tämä komentosarja on minimaalisesti määritetty esimerkki, omasta tuotantokoodistasi tulee erilainen).
    •  Lisää transientDocumentId-arvo koodissa merkittyyn paikkaan.
    { 
      "fileInfos": [ 
       {"transientDocumentId":"PASTE YOUR TRANSIENTDOCUMENTID HERE"} 
      ], 
      "name": "test doc", 
      "participantSetsInfo": [ 
        { 
          "memberInfos": [ 
            { 
              "email": "noreply@echosign.com" 
            } 
          ], 
          "order": 1, 
          "role": "SIGNER" 
        } 
      ], 
      "signatureType": "ESIGN", 
      "state": "DRAFT" 
    }

     

    • Kopioi mukautettu komentosarja ja liitä se AgreementInfo-kenttään.
    • Napsauta Kokeile! -painiketta.
    POST agreement -menetelmä

  3. Luodaan vastaus.

    agreementID-tunnus löytyy vastauksen tekstiosasta:

    POST agreement -menetelmän vastaus

Voit lisätä tiedostoja FileInfo-parametriin seuraavasti:

  1. Käytä tilapäistä tunnusta:

    Siirry POST/transientDocuments-kohtaan ja lähetä käytettävä dokumentti paikallisesta järjestelmästä.
    Käytä POST/Agreements-kohdan File Info -osiossa luotua tilapäistä tunnusta:

    "fileInfos": [ 
         { 
           "transientDocumentId": "" 
         } 
       ],
  2. Käytä kirjastodokumentin tunnusta:

    Siirry koontinäyttöön. Valitse Lisää dokumentti kirjastoon ja tallenna malli.
    Napsauta REST API:n dokumentaatiosta GET /libraryDocuments -kohtaa ja hae luotavan mallin kirjastotunnus.
    Anna POST/Agreements-kohdassa kirjastodokumentin tunnus:

    "libraryDocumentId": "", 
      "libraryDocumentName": "",
  3. Käytä julkisesti käytettävissä olevaa URL-osoitetta:

    Anna julkisesti käytettävissä oleva URL-osoite, jota haluat käyttää FileInfo-parametrissa:

    { 
          "documentURL": { 
            "mimeType": "", 
            "name": "", 
            "url": "" 
          },
  1. Valitse Agreements > POST/agreements -vaihtoehto. 

  2. Valitse Oauth Access-Token -vaihtoehto ja määritä tarvittavat käyttöalueet.

  3. Kun käyttöoikeustunnus on lisätty, voit käyttää seuraavaa pyyntökoodia:

    { 
    "documentCreationInfo": { 
         "recipientSetInfos": [ 
              { 
                   "recipientSetRole": "SIGNER", 
                   "recipientSetMemberInfos": [{"email": "testemail@email.com"}] 
              }, 
              { 
                   "recipientSetRole": "SIGNER", 
                   "recipientSetMemberInfos": [{"email": "testemail@email.com"}] 
              } 
         ], 
         "signatureFlow": "SEQUENTIAL", 
         "name": "husband wife", 
         "signatureType": "ESIGN", 
         "fileInfos": [ 
    { 
    "transientDocumentId": "(SAMPLE VALUE)3AAABLblqZhAJ9H6e23kZAfBUbItPvIhHTEyA6eZhziEp4KSntYcULpo43OEXwuWiWa-IM1r1EExYW0044CjCkliP4WFL5yKBUDq5DYSmSxVlFypcD0at8kK-BX-Mu3T9c_3GUqgDg0ArX0MmzWT72GLR_0M4Jq--mtuqGzq-VK1s-WGR6GcbedVY7XWAf3b3h-SpE08Hc-iF3zO7jQzi9newXSl-iW2JJsb_55tggkyxkXAkj74C1WD6KkJzgblK0JU-seh6QPDd0Fv6_mfQe2EPQA31nXj50aXwD_xlUBq7mg5FeaBnZ5bzgoqIWGHkbyeD2taaFdw*"} 
    ] 
    } 
    }

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"

  }

}

Huomautus:

Lähetä jonkun puolesta -toiminto on käytettävissä vain REST API V6:ssa, kun Edistyksellinen jako -toiminto on käytössä.

Jos jakoon ei ole myönnetty lähetysoikeutta tai jos Edistynyt jako -toiminto ei ole käytössä, saat seuraavan vastauksen:

 

{"code":"PERMISSION_DENIED","message":"User provided in x-on-behalf-of-user header does not have required permission to perform this operation."}

 

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 Edistyksellinen jako -toiminnosta on artikkelissa Edistyksellisen tilin jaon ottaminen käyttöön.

Kun Käyttäjien jako -toiminto on otettu käyttöön, suorita seuraavat toimet lähettääksesi jonkun toisen puolesta:

Tilapäisen dokumentin luominen:

  1. Valitse transientDocuments-kohdassa POST /transientDocuments.

  2. Luo valtuutustunnus napsauttamalla OAUTH ACCESS-TOKEN -painiketta.

  3. Anna x-on-behalf-of-user-kohdassa sen käyttäjän sähköpostiosoite, jonka puolesta haluat lähettää, seuraavassa muodossa: email:test@email.com

  4. Valitse tiedosto napsauttamalla Valitse tiedosto ja sitten Kokeile.

    Saat transientDocumentId-tunnuksella seuraavan vastauksen:

    {"transientDocumentId":"3AAABLblqZhB9Mjo0mrIu_pSgrf5VsMaKM68_Vmn80cimaqiUAD2OxrPp2e5H8GvjfiOxj4d5B8bCPkUfvaozW3KLisp_wseGVOL8A7oNZni1DWyFi4uNoxLQu4nUO44Wh63GQv9_HEJMePust0Pk94vJ_rbS96R7ic-vl7jbOkN0b4EB5-JMqlC-Fl_Vpyz8I1EQUrM5I4nB9ztMov4ad00yiOtDw0tB-Y2t5JdzM07P-mpJmwYEl8Fq2IeDuWjcR2tV7qY7TNGX2CNyh9jt0aMyduHeYa0GABr69z8Hm76eKdtaM_1E1ggWj205fSrNcwJsnpSO278*"}

Sopimuksen luominen tilapäisen dokumentin avulla:

  1. Valitse sopimuksissa POST /agreements.

  2. Luo valtuutustunnus napsauttamalla OAUTH ACCESS-TOKEN -painiketta.

  3. Kirjoita x-on-behalf-of-user-kohtaan käyttäjän sähköpostiosoite samalla tavalla kuin tilapäistä dokumenttia luotaessa.

  4. Lisää AgreementInfo-kohtaan seuraava koodi ja valitse Kokeile.

    { 
      "fileInfos": [ 
        {    "transientDocumentId":"3AAABLblqZhB9Mjo0mrIu_pSgrf5VsMaKM68_Vmn80cimaqiUAD2OxrPp2e5H8GvjfiOxj4d5B8bCPkUfvaozW3KLisp_wseGVOL8A7oNZni1DWyFi4uNoxLQu4nUO44Wh63GQv9_HEJMePust0Pk94vJ_rbS96R7ic-vl7jbOkN0b4EB5-JMqlC-Fl_Vpyz8I1EQUrM5I4nB9ztMov4ad00yiOtDw0tB-Y2t5JdzM07P-mpJmwYEl8Fq2IeDuWjcR2tV7qY7TNGX2CNyh9jt0aMyduHeYa0GABr69z8Hm76eKdtaM_1E1ggWj205fSrNcwJsnpSO278*" 
        } 
      ], 
      "name": "Test", 
      "participantSetsInfo": [ 
        { 
          "memberInfos": [ 
            { 
              "email": "signer@email.com" 
            } 
          ], 
          "order": 1, 
          "role": "SIGNER" 
        } 
      ], 
      "signatureType": "ESIGN", 
      "state": "IN_PROCESS" 
    }

     

    Saat agreementId-tunnuksella seuraavan vastauksen:

    { 
      
      "id": "CBJCHBCAABAAUlen3l_fzlj1Kbn_wGZAhYcIgN0J7Qtq" 
      
    }
  1. Kirjaudu Adobe Signiin.

  2. Siirry kohtaan Tili > Adobe Sign API > API:n tiedot ja valitse REST-sovellusrajapintamenetelmien ohjeet.

    Webhookin käyttöliittymä

  3. Suorita POST /transientDocuments, lähetä tiedosto ja luo tilapäisen dokumentin tunnus.

  4. Kopioi tilapäisen dokumentin tunnus ja käytä sitä POST /agreements -menetelmässä. Mainitse ruudussa seuraava JSON-pyyntö:

    { 
        "documentCreationInfo": { 
            "mergeFieldInfo": null, 
            "recipientSetInfos": [{ 
                    "signingOrder": null, 
                    "recipientSetRole": "SIGNER", 
                    "recipientSetMemberInfos": [{ 
                        "securityOptions": null, 
                        "email": "test1@gmail.com" 
                    }], 
                    "privateMessage": "Hello 1", 
                    "securityOptions": null 
                }, 
                { 
                    "signingOrder": null, 
                    "recipientSetRole": "SIGNER", 
                    "recipientSetMemberInfos": [{ 
                        "securityOptions": null, 
                        "email": "test2@gmail.com" 
                    }], 
                    "privateMessage": "Hello 2", 
                    "securityOptions": null 
                } 
            ], 
            "signatureType": "ESIGN", 
            "callbackInfo": null, 
            "message": "Please review and sign this document.", 
            "locale": "en_US", 
            "vaultingInfo": null, 
            "securityOptions": null, 
            "reminderFrequency": null, 
            "ccs": null, 
            "postSignOptions": null, 
            "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", 
            "daysUntilSigningDeadline": null, 
            "formFieldLayerTemplates": [], 
            "name": "Adobe Sign Agreement", 
            "formFields": null, 
            "fileInfos": [{ 
                "libraryDocumentName": null, 
                "transientDocumentId": "XXXXXXXXXXXX", 
                "documentURL": null, 
                "libraryDocumentId": null 
            }] 
        } 
    }
  5. Voit suorittaa JSON-pyynnön napsauttamalla Kokeile-painiketta.

    Webhookin käyttöliittymä

    Oikea JSON palauttaa sopimustunnuksen sisältävän vastauksen.

    Webhookin käyttöliittymä

Voit hyväksyä koodissa seuraavat parametrit avaussalasanan asettamista varten:

 

{

    "documentCreationInfo":

    [{

        "signatureType": "ESIGN",

               "recipientSetInfos": [{

            "recipientSetMemberInfos": [{                      

                "email": "abc@xyz.com"                  

            }],

                   

            "recipientSetRole": "SIGNER"                         

        }],

               "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED",

                   "fileInfos": [           {               

            "libraryDocumentId": "3AAABLblqZhBsm_vH7TVzU3hRdbtWuvzfTKDvBzaKZTiehjO2eGTk5Rlu02K-0BYn8HBJVFTWOmT_BQlrofPBlrCdjiJ_JI-V"        

        }       ],

               "name": "Avaussalasana dokumentin tarkastelua varten",

               "securityOptions": {        

            "openPassword": "1234",

                     "protectOpen": true   

        }

    }]

}

 

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:

 

{

  "fileInfos": [

    {

      "transientDocumentId": "*********************"

    }

  ],

  "name": "A1",

  "participantSetsInfo": [

    {

      "memberInfos": [

        {

          "email": "abc@xyz.com"

        }

      ],

      "order": 1,

      "role": "SIGNER"

    }

  ],

  "signatureType": "ESIGN",

  "state": "AUTHORING"

}

 

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:

  1. Siirry REST API V6:n dokumentaatioon ja valitse POST/agreements-menetelmä.

  2. Käytä seuraavaa pyyntökoodia:

    { 
      "fileInfos": [ 
        { 
          "transientDocumentId": "***************************" 
        } 
      ], 
      "name": "test", 
      "participantSetsInfo": [ 
        { 
          "memberInfos": [ 
            { 
              "email": "abc@gmail.com" 
            } 
          ], 
          "order": 1, 
          "role": "SIGNER" 
        } 
      ], 
      "signatureType": "ESIGN", 
      "state": "AUTHORING" 
    }
  3. Käytä put /agreements/{agreementId}/formFields -metodia, josta on esimerkkinä seuraava pyyntö:

    { 
      "fields": [ 
        { 
         "locations": [ 
              { 
                "height": 36, 
                "left": 75, 
                "pageNumber": "1", 
                "top": 200, 
                "width": 150 
              } 
            ], 
            "contentType": "SIGNATURE_BLOCK", 
            "name": "sigBlock1", 
            "inputType": "SIGNATURE", 
            "recipientIndex":1 
           } 
    ]}

     

    Sopimus lähetetään mainitulle vastaanottajalle, kun pyyntö on suoritettu.

  1. Kirjaudu Adobe Signiin.

  2. Siirry kohtaan Tili > Adobe Sign API > API:n tiedot ja valitse REST-sovellusrajapintamenetelmien ohjeet.

    Webhookin käyttöliittymä

  3. Suorita POST /transientDocuments, lähetä tiedosto ja luo tilapäisen dokumentin tunnus.

  4. Kopioi tilapäisen dokumentin tunnus ja käytä sitä POST /agreements -menetelmässä. Mainitse ruudussa seuraava JSON-pyyntö:

    { 
        "documentCreationInfo": { 
            "recipientSetInfos": [{ 
                    "recipientSetRole": "SIGNER", 
                    "recipientSetMemberInfos": [{ 
                        "email": "test1@gmail.com" 
                    }], 
                    "privateMessage": "Hello 1" 
                }, 
                { 
                    "recipientSetRole": "SIGNER", 
                    "recipientSetMemberInfos": [{ 
                        "email": "test2@gmail.com" 
                    }], 
                    "privateMessage": "Hello 2" 
                } 
            ], 
            "signatureType": "ESIGN", 
            "message": "Please review and sign this document.", 
            "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", 
            "name": "Demo1", 
            "fileInfos": [{ 
                "transientDocumentId": "XXXXXXXXXX" 
            }], 
            "formFields": [{ 
                    "hidden": "1", 
                    "defaultValue": "test1@gmail.com", 
                    "name": "Signer Email (Applicant-1)", 
                    "inputType": "TEXT_FIELD", 
                    "readOnly": true, 
                    "locations": { 
                        "pageNumber": 1, 
                        "top": 100, 
                        "left": 100, 
                        "width": 100, 
                        "height": 30 
                    }, 
      
                    "contentType": "SIGNER_EMAIL" 
                }, 
                { 
                    "name": "Signature (Applicant-2)", 
                    "inputType": "SIGNATURE", 
                    "locations": { 
                        "pageNumber": 1, 
                        "top": 520, 
                        "left": 162, 
                        "width": 280, 
                        "height": 30 
                    }, 
                    "contentType": "SIGNATURE", 
                    "required": 1, 
                    "recipientIndex": 1 
                }, 
                { 
                    "name": "Signature (Applicant-3)", 
                    "inputType": "SIGNATURE", 
                    "locations": { 
                        "pageNumber": 2, 
                        "top": 312, 
                        "left": 154, 
                        "width": 280, 
                        "height": 30 
                    }, 
                    "contentType": "SIGNATURE", 
                    "required": 1, 
                    "recipientIndex": 1 
                }, 
                { 
                    "defaultValue": "017/09/2018", 
                    "displayFormatType": "DATE", 
                    "name": "Signature Date (Applicant-4)", 
                    "format": "DATE_DD_MM_YYYY", 
                    "inputType": "TEXT_FIELD", 
                    "readOnly": true, 
                    "locations": { 
                        "pageNumber": 2, 
                        "top": 260, 
                        "left": 90, 
                        "width": 80, 
                        "height": 30 
                    }, 
                    "contentType": "DATA", 
                    "required": 1, 
                    "recipientIndex": 1 
                }, 
                { 
                    "name": "Signature (Applicant-5)", 
                    "inputType": "SIGNATURE", 
                    "locations": { 
                        "pageNumber": 3, 
                        "top": 199, 
                        "left": 179, 
                        "width": 276, 
                        "height": 30 
                    }, 
                    "contentType ": "SIGNATURE", 
                    "required": 1, 
                    "recipientIndex": 1 
                }, 
                { 
                    "contentType": "SIGNATURE_DATE", 
                    "defaultValue": "06/07/2018", 
                    "displayFormatType": "DATE", 
                    "name": "Signature Date (Applicant-6)", 
                    "format": "DATE_DD_MM_YYYY", 
                    "inputType": "TEXT_FIELD", 
                    "readOnly": true, 
                    "locations": { 
                        "pageNumber": 3, 
                        "top": 188, 
                        "left": 488, 
                        "width": 76, 
                        "height": 25 
                    }, 
                    "required": 1, 
                    "recipientIndex": 1 
                }, 
                { 
                    "name": "Signature (Applicant-7)", 
                    "inputType": "SIGNATURE", 
                    "locations": { 
                        "pageNumber": 3, 
                        "top": 370, 
                        "left": 37, 
                        "width": 210, 
                        "height": 26 
                    }, 
                    "contentType ": "SIGNATURE", 
                    "required": 1, 
                    "recipientIndex": 2 
                }, 
                { 
                    "contentType ": "SIGNATURE_DATE", 
                    "defaultValue": "01/02/2018", 
                    "name": "Signature Date (Applicant-8)", 
                    "locations": { 
                        "pageNumber": 3, 
                        "top": 370, 
                        "left": 300, 
                        "width": 76, 
                        "height": 26 
                    }, 
                    "required": 1, 
                    "recipientIndex": 2 
      
                } 
            ] 
        } 
    }
  5. Suorita JSON-pyyntö napsauttamalla Kokeile-painiketta.

    Webhookin käyttöliittymä

    Oikea JSON palauttaa sopimustunnuksen sisältävän vastauksen.

    Webhookin käyttöliittymä

  1. Kirjaudu Adobe Signiin.

  2. Siirry kohtaan Tili > Adobe Sign API > API:n tiedot ja valitse REST-sovellusrajapintamenetelmien ohjeet.

    Fnord.

  3. Suorita POST /transientDocuments, lähetä tiedosto ja luo tilapäisen dokumentin tunnus.

  4. Kopioi tilapäisen dokumentin tunnus ja käytä sitä POST /agreements -menetelmässä. Mainitse ruudussa seuraava JSON-pyyntö:

    { 
        "options": { 
            "noChrome": true, 
            "authoringRequested": true 
        }, 
        "documentCreationInfo": { 
            "recipientSetInfos": [{ 
                    "recipientSetRole": "SIGNER", 
                    "recipientSetMemberInfos": [{ 
                        "email": "test1@gmail.com" 
                    }], 
                    "privateMessage": "Hello 1" 
                }, 
                { 
                    "recipientSetRole": "SIGNER", 
                    "recipientSetMemberInfos": [{ 
                        "email": "test2@gmail.com" 
                    }], 
                    "privateMessage": "Hello 44" 
                } 
            ], 
            "signatureType": "ESIGN", 
            "message": "Please review and sign this document.", 
            "locale": "en_US", 
            "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", 
            "formFieldLayerTemplates": [], 
            "name": "Adobe Sign Agreement", 
            "formFields": null, 
            "fileInfos": [{ 
                "libraryDocumentName": null, 
                "transientDocumentId": "XXXXXXXXXXXX" 
            }] 
        } 
    }
  5. Suorita JSON-pyyntö napsauttamalla Kokeile-painiketta.

    Fnord.

    Oikea JSON palauttaa sopimustunnuksen sisältävän vastauksen.

    Fnord.

  6. Avaa sopimus sisällönluontitilassa kopioimalla URL-osoite ja liittämällä se selaimen osoiteriville.

  7. Vedä ja pudota lomakekentät haluttuun paikkaan.

  8. Lähetä sopimus allekirjoitettavaksi valitsemalla Lähetä. 

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ää.

 

{

"documentCreationInfo": {

"mergeFieldInfo": null,

"recipientSetInfos": [{

"signingOrder": null,

"recipientSetRole": "SIGNER",

"recipientSetMemberInfos": [{

"securityOptions": null,

"email": "Signer@email.com"

}],

 

"privateMessage": null,

"securityOptions": [{

"authenticationMethod": "PHONE",

"phoneInfos": [{

"phone": "1111111111",

"countryCode": "+1"

}]

}]

}],

 

"signatureType": "ESIGN",

"callbackInfo": null,

"message": "Tarkista ja allekirjoita tämä dokumentti.",

"locale": "en_US",

"vaultingInfo": null,

"securityOptions": null,

"reminderFrequency": null,

"ccs": null,

"postSignOptions": null,

"signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED",

"daysUntilSigningDeadline": null,

"formFieldLayerTemplates": [],

"name": "Adobe Sign Agreement-Phone authentication testing",

"formFields": null,

"fileInfos": [{

"libraryDocumentName": null,

"transientDocumentId": "3AAABLYourTransactionID",

"documentURL": null,

"libraryDocumentId": null

}]

},

 

"options": {

"autoLoginUser": true,

"authoringRequested": false,

"noChrome": true,

"sendThroughWeb": null,

"sendThroughWebOptions": null,

"locale": "en_US"

}

}

 

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:

 

"mergeFieldInfo": [

     {

       "defaultValue": "",

       "fieldName": ""

     }

   ],

 

  • 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:

 

"mergeFieldInfo": [

     {

       "defaultValue": "",

       "fieldName": ""

     }

   ],

 

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 Tilapäinen lähetys -vaihe ja hankkia transientDocumentId-tunnus (käyttämällä seuraavaa: secure.na1.echosign.com/public/docs/restapi/v5#!/transientDocuments/createTransientDocument), jota voi käyttää täällä.

  • 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:

 

Pyyntö:

POST /api/rest/v5/agreements HTTP/1.1

Isäntä: api.na1.echosign.com (tai voit määrittää pirstaleen nimen, jonka löydät käyttämällä getbaseURis-kutsua: https://secure.na1.echosign.com/public/docs/restapi/v5#!/base_uris/getBaseUris

Access-Token: 2AAABLblqZhA_D1mluNKQP7py5vXtt-1UHl9NR25e_C3LnKTUH14IblbrXODbXGRozyr7ChBkJNM*

x-user-email: sender@yourdomain.com

Content-Type: application/json

Cache-Control: no-cache

 

{

   "documentCreationInfo": {

       "signatureType": "ESIGN",

       "recipientSetInfos": [

           {

               "recipientSetMemberInfos": [

                   {

                       "email": “signerEmail@domain.com"

                   }

               ],

               "recipientSetRole": "SIGNER"

           }

        ],

      

       "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED",

       "message": "Allekirjoita tämä meiltä!",

       "fileInfos": [

           {

               "transientDocumentId": "3AAABLblqZhD1uP3ZnkJximC0JV1S677PR5xmybSJ-SJn6OtEy2tVqFyMN4xUAbhKTSkLw2Zb6HEF4zAGsrUd2ycoB8fFHQJhrci0O6267VztmIL4nCicSqvAjO7HckATHAsovVmuYwI9_FDDgHg0ogyti62L13HQFZIQRe9iyQMvvzbmksM7ODNK_HEepEKRCeJTtis9FOlz6uRCcIMNlbX_2GU8utWT"

           }

       ],

       "name": "MSA Edited”,

        "mergeFieldInfo": [

            {

                "fieldName": "AccountName",

                "defaultValue": "Sam's Garage"

            },

            {

                "fieldName": "AccountNumber",

                "defaultValue": "8756999"

            },

            {

                "fieldName": "Zip",

                "defaultValue": "94501"

            },

            {

                "fieldName": "City",

                "defaultValue": "CityVille"

            },

            {

                "fieldName": "State",

                "defaultValue": "CA"

            },

            {

                "fieldName": "Street",

                "defaultValue": "123 Some Road"

            },

            {

                "fieldName": "Title1",

                "defaultValue": "COO"

            },

            {

                "fieldName": "Description",

                "defaultValue": "Some new description here"

            }

        ]

   }

 

}

 

Vastaus tähän kutsuun on agreementId-tunnus, joka sinun on tallennettava järjestelmääsi myöhempiä kutsuja varten (signingUrl, status, formData jne.).

 

Vastaus:

{

  "agreementId": "3AAABLblqZhCf_7xDcrOgKFwAabp1S-OFfvUdHf2wJsSMwlB95_x_WdUeab67jOkJi1IJzWuSJ0zdNNKugS1blZB4LT5vNVyJ"

}

 

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.

Adobe 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 Adobe 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://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks/webhook_events.md

Kun URL-osoite ei noudata tätä protokollaa, Adobe 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ä.

Tämä työ on lisensoitu Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License -käyttöoikeuden mukaisesti.  Twitter™- ja Facebook-viestit eivät kuulu Creative Commons -ehtojen piiriin.


Sopimusta koskevien tietojen hallinta ja hankinta

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:

 

{

  "documentUpdateInfo": {

    "fileInfos": [

      {

        "agreementDocumentId": "",

        "transientDocumentId": ""

      }

    ]

  }

}

 

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

  1. Hanki POST/Agreement-menetelmällä haettu sopimustunnus.

  2. Hae uusin ETag Get /agreements/{agreementId} -menetelmällä.

  3. Siirry Put /agreements/{agreementId}/state -kohtaan ja anna seuraavat tiedot: "state": "IN_PROCESS"

Ei.

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

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

DELETE /agreements/ID -menetelmää käytetty sopimuksen piilottamiseksi 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ä.
Huomautus:

API-säilytystoimintoa ei ole otettu oletusarvoisesti käyttöön.

Jos haluat ottaa DELETE/agreements -toiminnon käyttöön, ota yhteyttä Success Manageriin ja pyydä, että API-säilytys otetaan tiliä varten käyttöön.

Lisätietoja tilisi säilytystoiminnon käyttöönotosta on artikkelissa Adobe Sign – Dokumenttien säilytys.

  1. Kirjaudu sisään Adobe Signin järjestelmänvalvojana ja siirry seuraavaan osoitteeseen: https://secure.adobesign.com/public/docs/restapi/v6.

    • Valitse agreeements ja laajenna GET /agreements -menetelmä.
    • Napsauta OAUTH ACCESS-TOKEN -painiketta.
    • Ota agreement_read:self-alue käyttöön.
    • Napsauta Valtuuta-painiketta.
      • Valitse pyydettäessä Salli käyttö.
    • Napsauta Kokeile! -painiketta
    Get Agreement -menetelmä

  2. Luodaan vastaus.

    agreementId-tunnus löytyy vastauksen tekstiosasta:

    Get Agreement -vastaus

  3. DELETE /agreements/{agreementId}/documents: Poistaa kaikki sopimukseen liittyvät dokumentit. Itse sopimus näkyy edelleen Hallinta-sivulla.

    • Valitse suoritettava DELETE/agreements-toiminto.
    • Napsauta OAUTH ACCESS-TOKEN -painiketta ja luo käyttöoikeustunnus areement_retention-alueella.
    • Anna poistettavan sopimuksen agreementId-tunnus.
    • Kun sopimus on poistettu, vastauksen tekstiosassa ei ole sisältöä.

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ä Adobe Sign -tiimiin asetusten ottamiseksi käyttöön.”

Ota selvää, miten voit ladata allekirjoitetun dokumentin ja valvontaraportin sekä tukidokumentaation Adobe Sign REST API:n kautta sen sijaan, että lataisit valvontaraportin seuraavalla menetelmällä.

GET /agreements/{agreementId}/auditTrail

  1. Valitse GET /agreements/{agreementId}/combinedDocument.

  2. Napsauta oAuth Access-token -painiketta.

  3. Käyttöoikeustunnus luodaan automaattisesti valtuutuksen hyväksymisen jälkeen.

  4. Anna agreementId-tunnus.

  5. Valitse attachSupportingDocuments-kohdan avattavasta luettelosta true.

  6. Valitse attachAuditReport-kohdan avattavasta luettelosta true.

  7. Napsauta Kokeile! -painiketta.

    Hanki yhdistetyt asiakirjat

    Tämä toiminto lataa allekirjoitetun dokumentin, tukidokumentaation ja valvontaraportin sisältävän PDF-tiedoston.

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


Kirjastomallit ja verkkolomakkeet

  1. Kirjaudu Adobe Signiin järjestelmänvalvojana ja siirry seuraavaan osoitteeseen: https://secure.na1.adobesign.com/public/docs/restapi/v6.

    • Valitse libraryDocuments ja laajenna GET /libraryDocuments -menetelmä.
    • Napsauta OAUTH ACCESS-TOKEN -painiketta.
    • Ota library_read:self-alue käyttöön.
    • Napsauta Valtuuta-painiketta.
      • Valitse pyydettäessä Salli käyttö.
    • Napsauta Kokeile!-painiketta.
    Get LibraryDocument -menetelmä

  2. Luodaan vastaus.

    libraryDocumentId löytyy vastauksen tekstiosasta:

    Get LibraryDocument -vastaus

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.

Voit toimia alla esitettyjen yksityiskohtaisten ohjeiden mukaan:

  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ä.
Huomautus:
  • Lähetä pyyntö tukitiimille, jotta kirjaston poistoalue otetaan käyttöön.
  • API poistaa kirjastodokumentin. Toiminnolla ei kuitenkaan ole vaikutusta tämän kirjastodokumentin avulla luotuihin sopimuksiin.


libraryDocumentID-tunnuksen luominen

  1. Siirry osoitteeseen https://secure.echosign.com/public/docs/restapi/v5.

  2. Valitse libraryDocuments.

  3. Napsauta oAuth Access-token -painiketta. 

    Myönnä käyttöoikeudet – Tunnus itselle, ryhmälle tai tilille.

  4. Valitse libraryTemplateType – Dokumentti tai Form_field_layer.

  5. Valitse Kokeile.

    Voit saada kaikille malleille seuraavan vastauksen. (Kopioi poistettavan kirjastomallin libraryDocumentId-tunnus.)

    { 
      "libraryDocumentList": [ 
        { 
          "name": "testing fields", 
          "modifiedDate": "2017-08-04T01:06:05-07:00", 
          "scope": "PERSONAL", 
          "libraryDocumentId": "3AAABLblqZhAK53Dvzq88Q1Ov0TEvMAySDPpIVjF1PWgUpy0H1uYggt4iwGiRSZYlWfl9ms_AcmgZ_uZMPPN2hNT9izwaspHc", 
          "libraryTemplateTypes": [ 
            "DOCUMENT" 
          ] 
        },


Kirjastomallien poistaminen

  1. Kopioi libraryDocumentID-tunnus vastauksen tekstiosasta.

  2. Siirry Delete libraryDocuments -kohtaan.

  3. Napsauta oAuth Access-token -painiketta. Myönnä käyttöoikeudet – Tunnus itselle, ryhmälle tai tilille.

  4. Liitä libraryDocumentId-tunnus Arvo-kenttään.

  5. Valitse Kokeile. 
    Malli poistetaan.

    Saat seuraavan vastauskoodin: 204

Huomautus:

Voit päivittää vain Luonnos-tilassa olevat verkkolomakkeet.

  1. Luo widgetti post /widgets -menetelmällä.

  2. Hanki widgetin tunnus get/widgets-kohdasta.

  3. Kun olet luonut widgetin GET /widgets/{widgetId} -menetelmällä, hae Etag vastauksen otsikosta.

    Foo

  4. Käytä put /widgets/{widgetId} -kohdassa GET /widgets/{widgetId} -menetelmän Etagia. Lisää If-Match-parametriin widgetId- ja widgetInfo-arvot.

    Foo

    { 
      "fileInfos": [ 
        { 
          "transientDocumentId": "******" 
        } 
      ], 
      "name": "Widht_Name", 
      "status": "DRAFT", 
      "widgetParticipantSetInfo": { 
        "memberInfos": [ 
          { 
            "email": "" 
          } 
        ], 
        "role": "SIGNER" 
      } 
    }


Esimerkkejä käyttötapauksista

  1. Tee get/agreements-kutsu oikealla x-api-user-arvolla.

  2. Etsi vastauksen tekstiosasta Lähetetty allekirjoitettavaksi -sopimus, jonka allekirjoitus-URL-osoitteen haluat löytää, ja kirjaa sopimustunnus muistiin.

  3. Tee get/agreements/{agreementId}/signingUrls-kutsu käyttämällä get/agreements-kutsusta saamaasi sopimustunnusta.

     

    Tulos

    Tuotos palauttaa allekirjoittajan sähköpostiosoitteen ja sähköisen allekirjoituksen URL-osoitteen.

    Get Agreement -menetelmä

Pyydä apua nopeammin ja helpommin

Oletko uusi käyttäjä?