Handboek Annuleren

Adobe Acrobat Sign-API - Veelgestelde vragen

Zoeken
Adobe Sign

Adobe Sign

App openen

 

Handboek voor Adobe Acrobat Sign

Nieuwe functies

  1. Voorafgaande aanvullende informatie
  2. Aanvullende informatie
  3. Belangrijke meldingen

Aan de slag

  1. Snelstartgids voor beheerders
  2. Handleiding om snel aan de slag te gaan voor gebruikers
  3. Voor ontwikkelaars
  4. Bibliotheek voor videotutorial
  5. Veelgestelde vragen

Beheerder

  1. Overzicht Admin Console
  2. User Management
    1. Gebruikers toevoegen
      1. Een gebruiker toevoegen
      2. Gebruikers in bulk toevoegen
      3. Gebruikers toevoegen vanuit uw map
      4. Gebruikers toevoegen vanuit de map MS Azure Active
    2. Op functies gerichte gebruikers maken
      1. Technische accounts: door API aangestuurd
      2. Serviceaccounts: handmatig aangestuurd
    3. Controleren op gebruikers met provisioningfouten
    4. Naam/e-mailadres wijzigen
    5. Groepslidmaatschap van een gebruiker bewerken
    6. Het groepslidmaatschap van een gebruiker bewerken via de groepsinterface
    7. Een gebruiker tot een beheerdersrol bevorderen
    8. Typen gebruikersidentiteiten en SSO
    9. Gebruikersidentiteit wisselen
    10. Gebruikers verifiëren met MS Azure
    11. Gebruikers verifiëren met Google Federation
    12. Productprofielen
    13. Aanmeldingservaring 
  3. Account-/groepsinstellingen
    1. Overzicht van instellingen
    2. Algemene instellingen
      1. Accountniveau en ID
      2. Nieuwe ervaring voor ontvangers
      3. Workflows voor zelfondertekening
      4. In bulk verzenden
      5. Webformulieren
      6. Workflows op maat verzenden
      7. Power Automate-workflows
      8. Bibliotheekdocumenten
      9. Formuliergegevens bij overeenkomsten verzamelen
      10. Beperkte documentzichtbaarheid
      11. Een PDF-kopie van de ondertekende overeenkomst bijvoegen 
      12. Een koppeling opnemen in de e-mail
      13. Een afbeelding opnemen in de e-mail
      14. Bestanden die bij een e-mail worden gevoegd, krijgen de naam
      15. Controlerapport bij documenten bijvoegen
      16. Meerdere documenten samenvoegen tot één document
      17. Afzonderlijke documenten downloaden
      18. Een ondertekend document uploaden
      19. Delegatie voor gebruikers in mijn account
      20. Externe ontvangers toestaan te delegeren
      21. Bevoegdheid om te ondertekenen
      22. Bevoegdheid om te verzenden
      23. Machtiging om elektronische zegels toe te voegen
      24. De standaard tijdzone instellen
      25. Een standaard datumnotatie instellen
      26. Gebruikers in meerdere groepen (UMG)
        1. Upgrade uitvoeren om UMG te gebruiken
      27. Machtigingen voor groepsbeheerder
      28. Ontvanger vervangen
      29. Controlerapport
        1. Overzicht
        2. Niet-geverifieerde toegang toestaan op de pagina voor transactieverificatie
        3. Herinneringen opnemen
        4. Weergavegebeurtenissen opnemen
        5. Aantal overeenkomstpagina's/bijlagen opnemen
      30. Voettekst van transactie
      31. In-product berichten en begeleiding
      32. Toegankelijke PDF's
      33. Nieuwe ontwerpfunctie
      34. Klant in de gezondheidszorg
    3. Account instellen
      1. Logo toevoegen
      2. Hostnaam/URL van bedrijf aanpassen    
      3. Bedrijfsnaam toevoegen
      4. URL-omleiding na overeenkomst
    4. Voorkeuren handtekening
      1. Goed ingedeelde handtekeningen
      2. Ontvangers toestaan om te ondertekenen door
      3. Ondertekenaars kunnen hun naam wijzigen
      4. Toestaan dat ontvangers hun opgeslagen handtekening gebruiken
      5. Aangepaste gebruiksvoorwaarden en openbaarmakingsbeleid
      6. Ontvangers door formuliervelden navigeren
      7. Overeenkomstworkflow opnieuw starten
      8. Weigeren te ondertekenen
      9. Stempelworkflows toestaan
      10. Vereisen dat ondertekenaars hun functie of bedrijf opgeven
      11. Ondertekenaars toestaan een schriftelijke handtekening af te drukken en te plaatsen
      12. Berichten tonen bij elektronisch ondertekenen
      13. Vereisen dat ondertekenaars een mobiel apparaat gebruiken om hun handtekening te maken
      14. Verzoeken om IP-adres van ondertekenaars
      15. Bedrijfsnaam en functie uitsluiten van deelnemingsstempels
    5. Digitale handtekeningen
      1. Overzicht
      2. Downloaden en ondertekenen met Acrobat
      3. Ondertekenen met cloudhandtekeningen
      4. Inclusief metadata voor identiteitsproviders
      5. Beperkte providers voor cloudhandtekeningen
    6. Elektronische zegels
    7. Digitale identiteit
      1. Gateway voor digitale identiteit
      2. Beleid voor identiteitscontrole
    8. Rapportinstellingen
      1. Nieuwe rapportervaring
      2. Klassieke rapportinstellingen
    9. Beveiligingsinstellingen
      1. Instellingen voor eenmalig aanmelden
      2. Instellingen voor Mij onthouden
      3. Wachtwoordbeleid voor aanmelden
      4. Wachtwoordsterkte voor aanmelden
      5. Duur van websessie
      6. Type PDF-versleuteling
      7. API
      8. Toegang tot gebruikers- en groepsgegevens
      9. Toegestane IP-bereiken
      10. Account delen
      11. Machtigingen voor account delen
      12. Besturingselementen voor het delen van overeenkomsten
      13. Identiteitsverificatie van ondertekenaars
      14. Wachtwoord voor ondertekening van overeenkomst
      15. Wachtwoordsterkte van het document
      16. Ondertekenaars blokkeren op geolocatie
      17. Telefoonverificatie
      18. KBA-verificatie op kennisbasis
      19. Pagina-extractie toestaan
      20. Verloopdatum documentkoppeling
      21. Een clientcertificaat voor webhooks/callbacks uploaden
      22. Tijdstempel
    10. Verzendinstellingen
      1. Verzendpagina na aanmelden tonen
      2. Ontvangersnaam bij verzenden vereisen
      3. Naamwaarden voor bekende gebruikers vergrendelen
      4. Toegestane ontvangersrollen
      5. Elektronische getuigen toestaan
      6. Ontvangersgroepen
      7. CC's
      8. Toegang tot overeenkomst voor de ontvanger
      9. Vereiste velden
      10. Documenten bijvoegen
      11. Velden afvlakken
      12. Overeenkomsten wijzigen
      13. Naam van overeenkomst
      14. Talen
      15. Privéberichten
      16. Toegestane handtekeningtypes
      17. Herinneringen
      18. Wachtwoordbeveiliging ondertekend document
      19. Overeenkomstbericht verzenden via
      20. Opties voor indentificatie van ondertekenaar
        1. Overzicht
        2. Wachtwoord voor ondertekening
        3. Eenmalig wachtwoord via e-mail
        4. Acrobat Sign-verificatie
        5. Telefoonverificatie
        6. Cloudgebaseerde digitale handtekening
        7. Verificatie op basis van kennis
        8. Overheids-ID
        9. Identiteitsrapporten van ondertekenaar
      21. Inhoudsbeveiliging
      22. Transacties met notaris inschakelen
      23. Documentverloopdatum
      24. Voorvertoning, handtekeningen plaatsen en velden toevoegen
      25. Handtekeningvolgorde
      26. Liquid Mode
      27. Besturingselementen voor aangepaste workflows
      28. Uploadopties voor de pagina voor elektronische ondertekening
      29. URL omleiden voor bevestiging na ondertekening
    11. Berichtsjablonen
    12. Bio-Pharma-instellingen
      1. Overzicht
      2. Verificatie verplichten
      3. Redenen voor ondertekening
    13. Workflowintegratie
    14. Notariële instellingen
    15. Betalingsintegratie
    16. Ondertekenaarberichten
    17. SAML-instellingen
      1. SAML-configuratie
      2. Microsoft Active Directory Federation Service installeren
      3. Okta installeren
      4. OneLogin installeren
      5. Oracle Identity Federation installeren
    18. Voorschriften voor gegevens
    19. Instellingen tijdstempel
    20. Extern archiveren
    21. Accounttalen
    22. E-mailinstellingen
      1. Koptekst-/voettekstafbeeldingen voor e-mail
      2. E-mailvoetteksten voor individuele gebruikers toestaan
      3. De e-mail met het ondertekeningsverzoek aanpassen
      4. De velden Aan en CC aanpassen
      5. Meldingen zonder koppeling inschakelen
      6. E-mailsjablonen aanpassen
    23. Migreren van echosign.com naar adobesign.com
    24. Configuratieopties voor ontvangers
  4. Begeleiding voor regelgevingsvereisten
    1. Toegankelijkheid
      1. Naleving van toegankelijkheid
      2. Toegankelijke formulieren met Acrobat desktop maken
      3. Toegankelijke AcroForms maken
    2. HIPAA
    3. AVG
      1. AVG: overzicht
      2. Een gebruiker redigeren
      3. Overeenkomsten van een gebruiker redigeren    
    4. 21 CFR deel 11 en EudraLex bijlage 11
      1. Validatiepakket 21 CRF deel 11
      2. Handboek 21 CFR en EudraLex bijlage 11
      3. Analyse van gedeelde verantwoordelijkheden
    5. Klanten in de gezondheidszorg
    6. IVES-ondersteuning
    7. Overeenkomsten archiveren
    8. Overwegingen voor EU/VK
      1. Grensoverschrijdende transacties tussen de EU en het Verenigd Koninkrijk en eIDAS
      2. HMLR-vereisten voor elektronisch ondertekende akten
      3. De gevolgen van Brexit voor de wetgeving inzake elektronische handtekeningen in het Verenigd Koninkrijk
  5. Overeenkomsten in bulk downloaden
  6. Uw domein claimen 
  7. Koppelingen voor het melden van misbruik

Overeenkomsten verzenden, ondertekenen en beheren

  1. Opties voor ontvangers
    1. Een e-mailherinnering annuleren
    2. Opties op de pagina voor elektronisch ondertekenen
      1. Overzicht van de pagina voor elektronisch ondertekenen
      2. Openen om de overeenkomst zonder velden te lezen
      3. Weigeren om een overeenkomst te ondertekenen
      4. Ondertekeningsbevoegdheid delegeren
      5. Deze overeenkomst herstarten
      6. Een PDF van de overeenkomst downloaden
      7. Geschiedenis van de overeenkomst weergeven
      8. Berichten over de overeenkomst weergeven
      9. Een elektronische handtekening naar een geschreven handtekening converteren
      10. Een geschreven handtekening naar een elektronische handtekening converteren
      11. Door formuliervelden navigeren
      12. De gegevens uit de formuliervelden wissen
      13. Vergroting en navigatie van de pagina voor elektronisch ondertekenen
      14. De taal wijzigen die wordt gebruikt in de tools en informatie van de overeenkomst
      15. Juridische kennisgevingen controleren
      16. Cookievoorkeuren voor Acrobat Sign aanpassen
  2. Overeenkomsten verzenden  
    1. Paginaoverzicht verzenden
    2. Een overeenkomst alleen naar uzelf verzenden
    3. Een overeenkomst naar anderen verzenden
    4. Schriftelijke handtekeningen
    5. Volgorde van ondertekening voor ontvangers
    6. In bulk verzenden
      1. Overzicht van de functie In bulk verzenden
      2. In bulk verzenden - Een bovenliggende sjabloon configureren
      3. In bulk verzenden - Het CSV-bestand configureren
      4. Een transactie annuleren via In bulk verzenden
      5. Herinneringen toevoegen aan In bulk verzenden
      6. Rapportage voor In bulk verzenden
  3. Velden in documenten opnemen
    1. In-app authoringomgeving
      1. Automatische velddetectie
      2. Velden slepen en neerzetten met de authoringomgeving
      3. Formuliervelden toewijzen aan ontvangers
      4. De rol Vooraf invullen
      5. Velden aanbrengen met een herbruikbare veldsjabloon
      6. Overdracht van velden naar een nieuwe bibliotheeksjabloon
      7. Bijgewerkte authoringomgeving bij het verzenden van overeenkomsten
    2. Formulieren met tekstlabels maken
    3. Formulieren maken met Acrobat (AcroForms)
      1. AcroForm maken
      2. Toegankelijke PDF's maken
    4. Velden
      1. Veldtypes
        1. Algemene veldtypes
        2. Inline-afbeeldingen
        3. Stempelafbeeldingen
      2. Veldinhoudsweergave
      3. Veldvalidaties
      4. Waarden van gemaskeerde velden
      5. Voorwaarden voor tonen/verbergen instellen
      6. Berekende velden 
    5. Veelgestelde vragen over ontwerpen
  4. Overeenkomsten ondertekenen
    1. Overeenkomsten ondertekenen die naar u zijn verzonden
    2. Invullen en ondertekenen
    3. Zelfondertekening
  5. Overeenkomsten beheren
    1. Overzicht pagina Beheren
    2. Overeenkomsten delegeren
    3. Ontvangers vervangen
    4. Documentzichtbaarheid beperken 
    5. Een overeenkomst annuleren 
    6. Nieuwe herinneringen maken
    7. Herinneringen voor beoordeling
    8. Een herinnering annuleren
    9. Toegang verkrijgen tot Power Automate-flows
    10. Meer handelingen...
      1. De werking van de zoekfunctie
      2. Een overeenkomst weergeven
      3. Een sjabloon maken op basis van een overeenkomst
      4. Overeenkomsten verbergen/zichtbaar maken
      5. Een ondertekend document uploaden
      6. Bestanden en velden van een verzonden overeenkomst wijzigen
      7. De verificatiemethode van een ontvanger bewerken
      8. Een vervaldatum toevoegen of wijzigen
      9. Een opmerking toevoegen aan een overeenkomst
      10. Een individuele overeenkomst delen
      11. Delen van een overeenkomst ongedaan maken
      12. Een individuele overeenkomst downloaden
      13. De afzonderlijke bestanden van een overeenkomst downloaden
      14. Het controlerapport van een overeenkomst downloaden
      15. De veldinhoud van een overeenkomst downloaden
  6. Controlerapport
  7. Rapportage en gegevensexports
    1. Overzicht
    2. Gebruikers toegang verlenen tot rapportage
    3. Rapportgrafieken
      1. Een nieuw rapport maken
      2. Overeenkomstrapporten
      3. Transactierapporten
      4. Rapport voor activiteit bij instellingen
      5. Een rapport bewerken
    4. Gegevensexports 
      1. Een nieuwe gegevensexport maken
      2. Gegevens exporteren van webformulieren
      3. Een gegevensexport bewerken
      4. De inhoud voor het exporteren van gegevens vernieuwen
      5. Een gegevensexport downloaden
    5. De naam van een grafiek/export wijzigen
    6. Een rapport/export dupliceren
    7. Een rapport/export plannen
    8. Een rapport/export verwijderen
    9. Transactiegebruik controleren

Geavanceerde voorzieningen en workflows voor overeenkomsten

  1. Webformulieren 
    1. Een webformulier maken
    2. Een webformulier bewerken
    3. Een webformulier in-/uitschakelen
    4. Webformulier verbergen/tonen
    5. URL- of scriptcode zoeken 
    6. Webformuliervelden vooraf invullen met URL-parameters
    7. Een webformulier opslaan dat u later kunt invullen
    8. Het formaat van een webformulier wijzigen
  2. Herbruikbare sjablonen (Bibliotheeksjablonen) 
    1. US Government-formulieren in de Acrobat Sign-bibliotheek
    2. Een bibliotheeksjabloon maken
    3. De naam van een bibliotheeksjabloon wijzigen
    4. Het type van een bibliotheeksjabloon wijzigen
    5. Het machtigingsniveau van een bibliotheeksjabloon wijzigen
    6. Een gedeelde sjabloon kopiëren, bewerken en opslaan
    7. De verzamelde veldgegevens voor een bibliotheeksjabloon downloaden
  3. Eigendom van webformulieren en bibliotheeksjablonen overdragen
  4. Power Automate-workflows 
    1. Overzicht van de Power Automate-integratie en opgenomen rechten
    2. De Power Automate-integratie inschakelen
    3. Contextuele acties op de pagina Beheren
    4. Gebruik van Power Automate bijhouden
    5. Een nieuwe flow maken (voorbeelden)
    6. Triggers die worden gebruikt voor flows
    7. Flows van buiten Acrobat Sign importeren
    8. Flows beheren
    9. Flows bewerken
    10. Flows delen
    11. Flows in- of uitschakelen
    12. Flows verwijderen
    13. Nuttige sjablonen
      1. Alleen beheerder
        1. Alle voltooide documenten in SharePoint opslaan
        2. Alle voltooide documenten in OneDrive voor Bedrijven opslaan
        3. Alle voltooide documenten in Google Drive opslaan
        4. Alle voltooide documenten in DropBox opslaan
        5. Alle voltooide documenten in Box opslaan
      2. Archivering van overeenkomst
        1. Uw voltooide documenten in SharePoint opslaan
        2. Uw voltooide documenten in OneDrive voor Bedrijven opslaan
        3. Uw voltooide documenten in Google Drive opslaan
        4. Alle voltooide documenten in DropBox opslaan
        5. Voltooide documenten in Box opslaan
      3. Archivering van webformulierovereenkomst
        1. Voltooide webformulierdocumenten in de SharePoint-bibliotheek opslaan
        2. Voltooide webformulierdocumenten in OneDrive voor Bedrijven opslaan
        3. Voltooide documenten in Google Drive opslaan
        4. Voltooide webformulierdocumenten in Box opslaan
      4. Data-extractie van de overeenkomst
        1. Formulierveldgegevens uit uw ondertekende document extraheren en Excel-blad bijwerken
      5. Overeenkomstmeldingen
        1. Aangepaste e-mailmeldingen met uw inhoud van de overeenkomst en ondertekende overeenkomst verzenden
        2. Adobe Acrobat Sign-meldingen ontvangen in een Teams-kanaal
        3. Adobe Acrobat Sign-meldingen ophalen in Slack
        4. Uw Adobe Acrobat Sign-meldingen ophalen in Webex
      6. Overeenkomst genereren
        1. Een document genereren uit het Power App-formulier en de Word-sjabloon en verzenden ter ondertekening
        2. Een overeenkomst genereren vanuit een Word-sjabloon in OneDrive en de handtekening ophalen
        3. Overeenkomst genereren voor geselecteerde Excel-rij, verzenden voor controle en ondertekening
  5. Workflows op maat verzenden
    1. Overzicht Workflow Aangepast verzenden
    2. Een nieuwe verzendworkflow maken
    3. Een verzendworkflow bewerken
    4. Een verzendworkflow activeren of deactiveren
    5. Een overeenkomst verzenden met een verzendworkflow
  6. Gebruikers en overeenkomsten delen
    1. Een gebruiker delen
    2. Overeenkomsten delen

Integreren met andere producten

  1.  Overzicht van Acrobat Sign-integraties 
  2. Acrobat Sign voor Salesforce
  3. Acrobat Sign voor Microsoft
    1. Acrobat Sign voor Microsoft 365
    2. Acrobat Sign voor Outlook
    3. Acrobat Sign voor Word/PowerPoint
    4. Acrobat Sign voor teams
    5. Acrobat Sign voor Microsoft PowerApps en Power Automate
    6. Acrobat Sign Connector voor Microsoft Search
    7. Acrobat Sign voor Microsoft Dynamics 
    8. Acrobat Sign voor Microsoft SharePoint 
  4. Overige integraties
    1. Acrobat Sign voor ServiceNow
    2. Acrobat Sign voor HR ServiceNow
    3. Acrobat Sign voor SAP SuccessFactors
    4. Acrobat Sign voor Workday
    5. Acrobat Sign voor NetSuite
    6. Acrobat Sign voor VeevaVault
    7. Acrobat Sign voor Coupa BSM Suite
  5. Door partners beheerde integraties
  6. Een integratiesleutel verkrijgen

Acrobat Sign Developer

  1. REST-API's 
    1. Documentatie bij methoden
    2. Handboek voor SDK/ontwikkelaars
    3. Veelgestelde vragen over API    
  2. Webhooks 
    1. Overzicht van webhook
    2. Een nieuwe webhook configureren
    3. Een webhook weergeven of bewerken
    4. Een webhook deactiveren of opnieuw activeren
    5. Een webhook verwijderen
    6. Tweezijdige SSL-certificaten
    7. Webhooks in de API

Ondersteuning en probleemoplossing

  1. Bronnen voor klantenondersteuning 
  2. Ondernemingsbronnen Customer Success 

API-toegang is exclusief gereserveerd voor accounts op ondernemings- en ontwikkelaarsniveau.

Koppelingen naar kerndocumentatie

REST-API 6 - Nuttige koppelingen:

Opmerking:

De ondersteuning voor de oude SOAP-API's is per mei 2021 beëindigd.

Alle klanten die de SOAP-API gebruiken, zouden zo spoedig mogelijk moeten migreren naar de REST-API.

Als u bent aangemeld, gaat u naar Account > Acrobat Sign API > API-informatie > REST-API's en documentatie.

Aanmelden bij Acrobat Sign


Algemene concepten

U kunt het document niet ontwerpen door de pagina in de webinterface te bekijken, of door middel van slepen en neerzetten. Ook kunt u geen ondertekenaarsrollen toewijzen met transientDocumentId via de API.

De aanroep transientDocuments retourneert de transientDocumentID, die 7 dagen geldig is.  U kunt de aanroep alleen gebruiken voor verdere API-aanroepen. De aanroep wordt opgeslagen op de API-server en krijgt deze id toegewezen. Upload een bestand en verwijs vervolgens naar de id in alle volgende API-aanroepen.

U kunt een document in de Agreement-methode niet rechtstreeks uploaden met behulp van de REST-API.

Conform de REST-vereiste moet u eerst een tijdelijk document maken en deze id vervolgens toepassen in de Agreement-, Widget- of Library-methoden als bestandsbron.

Het tijdelijke document is een onbewerkt bronbestand, zoals PDF, doc, docx, dat is geüpload naar de Adobe-servers. Dit is een gemakkelijke manier om uw basisdocument naar de API-servers te verzenden en een tijdelijk document op internet te plaatsen.

Ja, u kunt overeenkomsten plaatsen via workflows in v6 met behulp van API-aanroep POST /agreements. Geef de parameter workflowId door in de API-aanroep.

U kunt de workflowId van een workflow ophalen met GET /workflows-aanroep.

  1. Aanmelden bij Adobe Sign als beheerder

  2. Ga naar Account > Adobe Sign-API > API Request Log (API-aanvraaglogboek)

    API-logboeken

  1.  Meld u bij het Adobe Sign-account aan als beheerder

  2. Ga naar Account > Adobe Sign-API > API-informatie

  3. Klik op de koppeling REST-API-voorbeelden.

    Opmerking:

    De JavaScript-SDK downloaden: https://github.com/adobe-sign/AdobeSignJsSdk

Vanaf v6 is de optie "sendTroughWeb" is niet langer beschikbaar. Deze optie is vervangen door de optie state. Hierbij gaat het om de staat waarin de overeenkomst terechtkomt. Het statusveld kan alleen worden opgegeven in POST-aanroepen. Dit wordt nooit geretourneerd in GET /agreements/{ID} en wordt genegeerd indien opgegeven in de PUT /agreements/{ID}-aanroep. De uiteindelijke status van de overeenkomst kunt u opvragen via GET /agreements/ID.

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

AUTHORING geeft een gebruiker de mogelijkheid om de documenten van een overeenkomst te ontwerpen voordat ze worden verzonden. Deze bewerking verwijst hier naar het maken, bewerken of plaatsen van formuliervelden samen met hun configuraties (toegewezen persoon, voorwaarden, gegevenstype, enzovoort) in de documenten van de overeenkomst. Nadat het document in de status Authoring is geplaatst, is het document zichtbaar in de sectie Concept van het Adobe Sign-tabblad Beheren.

CONCEPT is een tijdelijke of primitieve fase van de uiteindelijke beoogde bron die stapsgewijs kan worden bijgewerkt om de uiteindelijke bron te maken. Dit is niet zichtbaar in de sectie Concept van het Adobe Sign-tabblad Beheer. Als u de conceptstatus gebruikt, zijn de gegevens van de deelnemersset niet vereist en kunnen deze later worden toegewezen tijdens het uitvoeren van PUT /agreements/agreementId om dit concept te voltooien. Deze stap kan een aantal keren worden herhaald totdat u over alle vereiste gegevens beschikt om de overeenkomst te maken.

IN_PROCESS wijzigt de overeenkomststatus in Uit voor ondertekening en is zichtbaar in de sectie Uit voor ondertekening van het Adobe Sign-tabblad Beheer.

Met sendThroughWeb kunt u de overeenkomst interactief versturen. Met de verschillende parameters in het veld 'opties' in de v5-aanvraag POST /agreements kan de gebruiker deze interactieve weergave configureren (pagina Verzenden). Al deze parameters voor paginaconfiguratie zoals bijvoorbeeld fileUploadOptions worden verplaatst naar POST /agreements/ID/views-API.

In feite bereikt u dus het effect van sendThroughWeb door een overeenkomst te maken in de status AUTHORING via de POST /agreements-API. Als u vervolgens wilt vragen naar de URL van de volgende pagina in de gewenste configuratie, roept u de API in POST /agreements/ID/views aan.

Voer de volgende stappen uit:

1. Ga naar de REST-API V6-documentatie en selecteer de methode POST /agreements.
2. Gebruik de volgende aanvraagcode:

{

  "fileInfos": [

    {

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

    }

  ],

  "name": "test",

  "participantSetsInfo": [

    {

      "memberInfos": [

        {

          "email": "abc@gmail.com"

        }

      ],

      "order": 1,

      "role": "SIGNER"

    }

  ],

  "signatureType": "ESIGN",

  "state": "AUTHORING"

}

 

3. Gebruik nu de methode post /agreements/{agreementId}/views met de onderstaande aamvraagcode:

 

{

  "name": "AUTHORING"

}

De reactiecode biedt de URL voor het schrijven van velden.

Men kan de callback-URL op de onderstaande manieren definiëren:

  • Gebruik de onderstaande parameter om de callback-URL naar wens te definiëren:

    "callbackInfo": "",
  • Neem contact op met Adobe Sign-ondersteuning om de standaard-callback-URL in te stellen voor het volledige account.

SOAP UI (SmartBear) krijgt een SSL-verbindingsfout die lijkt op de volgende, die u krijgt wanneer u een API-aanroep doet. Deze fout treedt meestal op als u een verouderd SSL- of TLS-protocol gebruikt dat lager is dan TLS1.2

FOUT: uitzondering in aanvraag: javax.net.ssl.SSLException: fatale waarschuwing ontvangen: protocol_version
FOUT: er is een fout opgetreden [Fatale waarschuwing ontvangen: protocol_version], zie foutenlogboek voor details

  1. Voeg (-Dsoapui.https.protocols = SSLv3, TLSv1.2) toe aan het VMOPTIONS-bestand onder de Bin-map.

  2. Ga naar C:\Program Files\SmartBear\SoapUI-5.2.1\bin (afhankelijk van waar u de SOAP-gebruikersinterface hebt geïnstalleerd. Mogelijk onder C:\Program Files (x86))

  3. Schakel volledige lees-/schrijfbestandsrechten in voor het VMOPTIONS-bestand.

    VMOPTIONS

  4. Klik met de rechtermuisknop op VMOPTIONS-bestand > Eigenschappen > Tabblad Beveiliging> Gebruiker selecteren > Klik op Bewerken. (Het pictogram Gebruikerstoegangscontrole verschijnt op de knop Bewerken) > Schakel alle selectievakjes in en klik op OK.

  5. Herhaal dit proces voor beheerders, systemen en alle applicatiepakketten.

  6. Open het bestand met het kladblok.

  7. Voeg het protocol "-Dsoapui.https.protocols=SSLv3,TLSv1.2" onderaan toe en sla de wijzigingen op.

  8. Sluit de SOAP-gebruikersinterface en start het opnieuw op. Er wordt nu geen SSL-fout gegenereerd wanneer u een API-aanroep doet. (Voer een ping-aanroep uit als test om dit te controleren).

Hieronder volgen de stappen om een client-id en clientgeheim te maken in de Adobe Sign-applicatie:

  1. Meld u aan bij het Adobe Sign-account.

  2. Ga naar Account > Adobe Sign-API > API-applicaties

    Fnord.

  3. Om een applicatie te maken, klikt u op het pictogram met het plusteken.

    Fnord.

  4. Voer naam en weergavenaam in.

  5. Selecteer CUSTOMER (KLANT) onder Domein en klik op Opslaan.

    Fnord.

  6. Markeer de applicatie met een enkele klik.

  7. Klik op OAuth voor applicatie configureren.

    Fnord.

  8. Voer de omleidings-URI in.

  9. Om de vereiste bereiken in te schakelen, selecteert u de respectievelijke selectievakjes en klikt u op Opslaan.

  1. Meld u bij Adobe Sign aan als accountbeheerder

  2. Ga naar Account > Adobe Sign-API > API-informatie

  3. Klik op de koppeling Integratiesleutel

    Ga naar de integratiesleutel

    Opmerking:

    Als u de koppeling Integratiesleutel niet ziet, neem dan contact op met uw Succesmanager om uw account te laten inschakelen.

    • Geef de sleutel een naam met een intuïtieve waarde
    • Selecteer de verschillende bereiken die zijn vereist voor uw applicatiefunctie
    • Klik op Opslaan wanneer de sleutel is geconfigureerd
    De interface Integratiesleutel maken

  5. Eenmaal opgeslagen, is de sleutel te vinden in: Account > Persoonlijke voorkeuren > Toegangstokens

    De naam van de sleutel en alle ingeschakelde bereiken worden weergegeven.  

    Klik eenmaal op de sleutelbeschrijving om de actiekoppelingen weer te geven:

    • Integratiesleutel - Deze koppeling biedt u de letterlijke sleutel 
    • Intrekken - Hiermee wordt het toegangstoken definitief ingetrokken en verwijderd
    Toegangstokens - Integratiesleutel

  1. Meld u aan bij het Adobe Sign-account.

  2. Ga naar Account > Adobe Sign-API > API-applicaties

  3. Klik op het pluspictogram om een applicatie te maken.

    Postman1

  4. Klik op OAuth voor applicatie configureren.

    Fnord.

  5. Genereer de autorisatiecode met behulp van de volgende koppeling. De client-ID, omleidings-URI en bereiken moeten hetzelfde zijn als in de volgende URL zoals geselecteerd in de applicatie (gebruik geen spaties in de volgende URL en de op een Shard lijkende NA1 is volgens het Adobe Sign-account waartoe het behoort):

    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. Als de aanroep is gelukt, kiest u de autorisatiecode in de adresbalk.

    Fnord.

  7. Download en installeer Postman via de koppelinghttps://www.getpostman.com/apps.

  8. Zodra het programma is gedownload en geïnstalleerd, klikt u op NIEUW om een POST te maken.

  9. Voer de koppeling https://secure.na1.echosign.com/oauth/token in die overeenkomt met uw Adobe Sign-account.

  10. Voer het volgende in onder Headers: Content-Type as application/x-www-form-urlencoded.

  11. Zorg ervoor dat x-www-form-urlencoded is geselecteerd onder de Body-tekst en voer de onderstaande parameters in met de bijbehorende waarden uit de applicatie die is gemaakt in Adobe Sign-account. Klik op SEND (VERZENDEN).

    Fnord.

  12. Als alle informatie correct is, worden het toegangstoken en het vernieuwingstoken in de reactie geretourneerd:

    Fnord.

Zorg ervoor dat u de onderstaande punten volgt tijdens het uitvoeren van het OAuth-proces:

1. De juiste client-id en omleidings-URI zijn opgegeven.
2. De bereiken in de autorisatie-URL moeten exact overeenkomen met de bereiken in de Adobe Sign-applicatie.
3. Gebruik de juiste shard (na1, na2, au1, eu1, jp1) volgens het account dat wordt geconfigureerd.
4. Verwijder spaties in de autorisatie-URL (indien aanwezig).
5. Controleer de syntaxis van de autorisatie-URL:

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

Toegangstokens zijn slechts 3600 seconden (één uur) geldig, waarna ze vervallen.

De houder van de API-aanvraag kan Refresh-tokens gebruiken om, indien nodig, nieuwe toegangstokens te genereren.

Webhooks worden ondersteund in REST-API v6 en later.

Als een Webhook-ontvanger niet binnen 72 uur reageert, wordt de webhook zonder melding uitgeschakeld.

Als de doel-URL voor de webhook om welke reden dan ook niet beschikbaar is, wordt de JSON-bewerking door Adobe Sign in de wachtrij geplaatst en wordt de push-bewerking 72 uur in een progressieve cyclus opnieuw geprobeerd.

De niet-afgeleverde gebeurtenissen blijven in een wachtrij voor opnieuw proberen staan en in de volgende 72 uur wordt er alles aan gedaan om de meldingen af te leveren in de volgorde waarin ze zijn opgetreden.

De strategie voor levering van meldingen opnieuw is geworden tijd tussen pogingen om te beginnen met het interval dat 1 minuten tot 12 uur toeneemt, probeert de resulterende in- 15 in de ruimte van 72 uur nogmaals.

 

Als u een webhook rechtstreeks vanuit de Adobe Sign-gebruikersinterface wilt maken, maakt u eerst een webhook-URL via Azure AD-functie-apps door de onderstaande stappen te volgen:

  1. Aanmelden via Microsoft-account: https://portal.azure.com/.

  2. Registreer uzelf voor Functie-apps onder het Azure AD-account.

    Azure-menu

  3. Ga naar Azure AD en ga naar Functie-apps > Klik op het pictogram voor functies.

  4. Selecteer Webhook-API met Javascript als taal en klik op Create Function (Functie maken).

    Azure API-gebruikersinterface

  5. Vervang het bestand Index.js door het volgende codefragment:

    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. Klik op de knop Test in de rechterhoek en geef de volgende koptekst op:

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

    API-test

  7. Klik op Opslaan en uitvoeren.

  8. Zodra u 200 OK-antwoorden met de volgende header hebt ontvangen, klikt u op Get function-URL (Functie-URL ophalen)

    200 reactie

  9. Kopieer de URL en ga naar Adobe Sign-gebruikersinterface > Webhooks > klik op het pluspictogram om de webhook te maken.

  10. Voer de volgende informatie in: 

    • Naam: gebruik een intuïtieve naam die eenvoudig wordt begrepen door andere beheerders.
    • Bereik: hoe groot is het 'vangnet' van de webhook? Account en Groep zijn beschikbaar in de interface.
      De API biedt ondersteuning voor de bereiken Account, Groep, Gebruiker en Bron.
    • Er kan slechts één bereik per webhook worden gedefinieerd
    • URL: het doel-URL waarnaar Adobe Sign de JSON-lading pusht.
    • Gebeurtenissen: de 'activeringstrigger' die ervoor zorgt dat Adobe Sign de JSON-code bouwt en naar de URL pusht.
      Elke gebeurtenis bouwt een andere payload op die relevant is voor de triggergebeurtenis
      Meerdere gebeurtenissen kunnen in één webhook worden opgenomen.
    • Meldingsparameters: met meldingsparameters worden de secties van de 'Event JSON'-payload aangeduid, zodat u alleen de secties van de gebeurtenis kunt selecteren die voor u van belang zijn.
    Webhook-gebruikersinterface

  11. Zodra de webhook volledig is gedefinieerd, klikt u op Opslaan, waarna de webhook direct kan reageren op activeringsgebeurtenissen.

De overeenkomst-asset is een asset waarmee u een overeenkomst kunt maken, zoals bijvoorbeeld 'bibliotheekdocument', 'widget' of 'overeenkomst'.

Als u naar Agreement Asset Events wilt zoeken, moet u eerst een aanvraag indienen bij de API waarmee agreementAssetEvents wordt gemaakt met de relevante zoekparameters.

De reactie bestaat uit de eerste pagina met resultaten, samen met een zoek-id-parameter en de cursor voor de volgende pagina. Hiermee kunt u meer paginaresultaten ophalen als deze beschikbaar zijn met behulp van de API, waarbij agreementAssetEvents worden opgehaald op basis van de zoek-id.

  1. Open de REST-API-documentatie voor versie 5.

  2. Ga naar POST /search/agreementAssetEvents en genereer het toegangstoken met de relevante bereiken.

  3. Definieer de start- en einddatum in de aanvraagcode, zoals vereist:

    { 
  "endDate": "2018-05-22T22:33:33", 
  "startDate": "2017-12-22T22:33:33" 
}

  4. Klik op Probeer het uit. Hiermee worden de overeenkomt-asset-id's opgehaald, die tevens kunnen worden gebruikt als overeenkomst-id's.


Gebruikers- en accountbeheer

  1. Meld u aan bij Adobe Sign.
  2. Ga naar Account > Adobe Sign-API > REST-API-documentatie.
  3. Selecteer versie 5.
  4. Onder de post/users-methode gebruikt u de aanvraagcode die wordt vermeld onder
    UserCreationInfo-methode
    {
    "email": "email@email.com",
    "firstName": "AA",
    "lastName": "AB",
    "password":"12******rte"
    }

Adobe Sign-accounts die hun gebruikersrechten beheren via Admin Console (Adobe One), kunnen geen gebruikers maken of bestaande gebruikers beheren via de Adobe Sign-API.

Adobe One Admin Console gebruikt een andere API dan de Adobe Sign-API. Raadpleeg deze artikelen voor meer informatie:

 

Groep-id ophalen:

  1. Ga naar https://secure.na1.echosign.com/public/docs/restapi/v5.

  2. Ga naar Resources and Operations (Bronnen en bewerkingen) en klik op groepen.

  3. Klik op GET /groups.

  4. Klik op de knop oAuth Access-token.

  5. Genereer het toegangstoken.

  6. Klik op de knop Probeer het uit.

    U krijgt de volgende reactie voor de groepsnaam en groeps-id:

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

Groep verwijderen:

  1. Klik op DELETE /groups/{groupId}.

  2. Klik op de knop oAuth-Access-token om een toegangstoken te maken.

  3. Voeg de groep-id toe die u hebt ontvangen in de reactie op de vorige aanroep. Dit is de id van de groep die u wilt verwijderen in het vak groupId.

  4. Klik op Probeer het uit.

    Zodra de groep is verwijderd, ontvangt u de volgende reactie: Geen inhoud

Opmerking:

U kunt geen groep verwijderen waaraan een gebruiker is toegewezen. Eigenlijk kunt u alleen de lege groep verwijderen. U krijg de volgende reactie als de groep een gebruiker bevat.


{

  "code": "GROUP_NOT_EMPTY",

  "message": "The group cannot be deleted because it is not empty."

}


Overeenkomsten starten/verzenden

Een tijdelijk document genereren

  1. Ga naar https://secure.na1.adobesign.com/public/docs/restapi/v6

  2. Klik op transientDocuments en vouw de methode POST /transientDocuments uit

  3. Klik op de knop OAuth-Access-token

    De API TransientDocument-methode

    • Schakel de bereiken in voor de transactie
    • Klik op Autoriseren
    OAuth-bereiken

  5. Toegang verschaffen

    Klik op Toegang verlenen als u hierom wordt gevraagd

  6. U keert terug naar de pagina met API-methoden. De autorisatiewaarde is nu ingevuld.

    • Voer de bestandsnaam in het veld Bestandsnaam in
    • Klik op de knop Bestand kiezen en upload het document voor de overeenkomst
    • Klik op Probeer het uit!
    Probeer het uit!

  7. De reactie wordt gegenereerd.

    De transientDocumentID is te vinden in de hoofdtekst van de reactie:

    Id van tijdelijk document

Een overeenkomst maken met behulp van het tijdelijke document

  1. Ga naar https://secure.na1.adobesign.com/public/docs/restapi/v6

  2. Klik op agreements en vouw de methode POST /agreements uit

    • Klik op de knop OAuth-Access-token
    • Schakel het OAuth-bereik in
    • Klik op Autoriseren
      • Klik op Toegang verlenen als u hierom wordt gevraagd

  4. U keert terug naar de pagina met API-methoden. De autorisatiewaarde is nu ingevuld.

    • Kopieer het onderstaande script naar een teksteditor (dit script is slechts een minimaal geconfigureerd voorbeeld; uw productiecode zal anders zijn)
    •  Plaats uw trasientDocumentId-waarde in de code waar aangegeven
    { 
  "fileInfos": [ 
   {"transientDocumentId":"PASTE YOUR TRANSIENTDOCUMENTID HERE"} 
  ], 
  "name": "test doc", 
  "participantSetsInfo": [ 
    { 
      "memberInfos": [ 
        { 
          "email": "noreply@echosign.com" 
        } 
      ], 
      "order": 1, 
      "role": "SIGNER" 
    } 
  ], 
  "signatureType": "ESIGN", 
  "state": "DRAFT" 
}

     

    • Kopieer uw aangepaste script en plak het in het veld AgreementInfo
    • Klik op Probeer het uit!
    De POST agreement-methode

  5. De reactie wordt gegenereerd.

    De agreementID is te vinden in de hoofdtekst van de reactie:

    Reactie voor de POST agreement-methode

Hieronder staan de stappen waarmee u bestanden kunt toevoegen aan de FileInfo-arameter:

  1. Gebruik een tijdelijke id:

    Ga naar POST /transientDocuments en upload het document dat u vanaf uw lokale systeem wilt gebruiken.
    Gebruik de tijdelijke ID die is gegenereerd onder de sectie File Info (Bestandsinfo) in POST/agreements:

    "fileInfos": [ 
     { 
       "transientDocumentId": "" 
     } 
   ],

  2. Een bibliotheekdocument-id gebruiken:

    Ga naar het dashboard. Klik op Add document to Library (Document aan bibliotheek toevoegen) en sla de sjabloon op.
    Ga naar REST-API-documentatie, klik op GET/libraryDocuments en haal de bibliotheek-ID op voor de sjabloon die wordt gemaakt.
    Geef onder POST /agreements de ID van het bibliotheekdocument op:

    "libraryDocumentId": "", 
  "libraryDocumentName": "",

  3. Gebruik een openbaar beschikbare URL:

    Geef de openbaar toegankelijke URL op die moet worden gebruikt onder de parameter FileInfo:

    { 
      "documentURL": { 
        "mimeType": "", 
        "name": "", 
        "url": "" 
      },

  1. Ga naar https://secure.na1.adobesign.com/public/docs/restapi/v6.

  2. Selecteer de optie Agreements (Overeenkomsten) > POST /agreements. 

  3. Selecteer de optie Oauth Access-Token en geef de benodigde bereiken op.

  4. Nadat het toegangstoken is toegevoegd, kunt u de volgende aanvraagcode gebruiken:

    { 
"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*"} 
] 
} 
}

In de POST/agreements-aanroep kunt u voor de parameter signatureflow de waarde SENDER_SIGNS_FIRST of SENDER_SIGNS_LAST doorgeven om de afzender respectievelijk als eerste of laatste ondertekenaar toe te voegen.

Dit is een voorbeeld van de aanroep in de JSON-indeling:

{

  "documentCreationInfo": {

    "fileInfos": [

      {        "transientDocumentId":"3AAABLblqZ-yourIDGoesHere"

      }

    ],

    "name": "Test",

    "recipientSetInfos": [

      {

        "recipientSetMemberInfos": [

          {

            "email": "test@email.com"

          }

        ],

        "recipientSetRole": "SIGNER"

      }

    ],

    "signatureType": "ESIGN",

    "signatureFlow": "SENDER_SIGNS_FIRST"

  }

}

Opmerking:

De optie voor verzenden namens is alleen beschikbaar in REST-API v6 indien Geavanceerd delen is ingeschakeld.

Als er geen toestemming voor verzenden is verleend bij het delen, of als de optie voor vooraf delen niet is ingeschakeld, krijgt u de volgende reactie:

 

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

 

Schakel voor de functie 'Verzenden namens' de optie 'Geavanceerd delen van accounts' in voor het account, zodat gebruikers verzendmachtigingen kunnen geven aan andere gebruikers terwijl ze hun account delen. Zie Geavanceerd delen van accounts inschakelen voor geavanceerd delen.

Zodra het delen van gebruikers is ingeschakeld, doorloopt u de volgende stappen om de optie Verzenden namens in te schakelen:

Een tijdelijk document genereren:

  1. Ga naar https://secure.adobesign.com/public/docs/restapi/v6.

  2. Klik onder transientDocuments op POST /transientDocuments.

  3. Om een token voor autorisatie te genereren, klikt u op de knop OAUTH ACCESS-TOKEN.

  4. Geef bij 'x-on-behalf-of-user' de e-mail op van de gebruiker namens wie u wilt gaan verzenden. Gebruik de volgende indeling: e-mail:test@email.com

  5. Om een bestand te selecteren, klikt u op Choose File (Bestand kiezen). Klik op Probeer het uit.

    U krijgt de volgende reactie met transientDocumentId:

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

Een overeenkomst maken met behulp van het tijdelijke document

  1. Klik onder de optie voor overeenkomsten op POST /agreements.

  2. Om een token voor autorisatie te genereren, klikt u op de knop OAUTH ACCESS-TOKEN.

  3. Geef bij 'x-on-behalf-of-user' het e-mailadres op van de gebruiker, zoals bij het maken van het tijdelijke document.

  4. Voeg in AgreementInfo de volgende code toe en klik op Probeer het uit.

    { 
  "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" 
}

     

    U krijgt de volgende reactie met agreementId:

    { 
  
  "id": "CBJCHBCAABAAUlen3l_fzlj1Kbn_wGZAhYcIgN0J7Qtq" 
  
}

  1. Meld u aan bij Adobe Sign.

  2. Ga naar Account > Adobe Sign-API > API-informatie en klik op REST-API-methode - Documentatie.

    Webhook-gebruikersinterface

  3. Gebruik POST /transientDocuments, upload een bestand en maak een id voor een tijdelijk document.

  4. Kopieer de id voor het tijdelijke document en gebruik deze in de POST /agreement-methode. Vermeld de volgende JSON-aanvraag in het vak:

    { 
    "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. Klik op de knop Uitproberen om de JSON-aanvraag uit te voeren.

    Webhook-gebruikersinterface

    De juiste JSON retourneert het antwoord met de overeenkomst-ID.

    Webhook-gebruikersinterface

Hieronder staan de parameters die u in de code kunt doorgeven om een open wachtwoord in te stellen:

 

{

    "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": "Open password to view document",

               "securityOptions": {        

            "openPassword": "1234",

                     "protectOpen": true   

        }  

    }]

}

 

Voer de volgende stappen uit om een overeenkomst te maken via een API met de status 'AUTHORING':

Ga naar Post / agreements en maak een toegangstoken met de vereiste bereiken.

Gebruik de volgende aanvraagcode:

 

{

  "fileInfos": [

    {

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

    }

  ],

  "name": "A1",

  "participantSetsInfo": [

    {

      "memberInfos": [

        {

          "email": "abc@xyz.com"

        }

      ],

      "order": 1,

      "role": "SIGNER"

    }

  ],

  "signatureType": "ESIGN",

  "state": "AUTHORING"

}

 

Versie v6 heeft een set authoring-API's om een overeenkomst te ontwerpen. In v5 worden formFields rechtstreeks geconsumeerd in de POST /agreements-API. In v6 kan de gebruiker echter via v6 POST /agreements een overeenkomst in de ontwerpstatus maken (state = AUTHORING). Op een later tijdstip kunnen dan via PUT /agreements/ID/formFields ook formuliervelden worden toegevoegd aan de documenten van deze overeenkomst.

Hieronder vindt u de benodigde stappen:

  1. Ga naar REST-API V6-documentatie en selecteer de POST /agreements-methode.

  2. Gebruik de volgende aanvraagcode:

    { 
  "fileInfos": [ 
    { 
      "transientDocumentId": "***************************" 
    } 
  ], 
  "name": "test", 
  "participantSetsInfo": [ 
    { 
      "memberInfos": [ 
        { 
          "email": "abc@gmail.com" 
        } 
      ], 
      "order": 1, 
      "role": "SIGNER" 
    } 
  ], 
  "signatureType": "ESIGN", 
  "state": "AUTHORING" 
}

  3. Gebruik de methode put /agreements/{agreementId}/formFields met de volgende aanvraag als voorbeeld:

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

     

    Hiermee wordt de overeenkomst naar de genoemde ontvanger verzonden zodra de aanvraag is voltooid.

  1. Meld u aan bij Adobe Sign.

  2. Ga naar Account > Adobe Sign-API > API-informatie en klik op REST-API-methode - Documentatie.

    Webhook-gebruikersinterface

  3. Gebruik POST /transientDocuments, upload een bestand en maak een id voor een tijdelijk document.

  4. Kopieer de id voor het tijdelijke document en gebruik deze in de POST /agreement-methode. Vermeld de volgende JSON-aanvraag in het vak:

    { 
    "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. Klik op de knop Probeer het uit om de JSON-aanvraag uit te voeren.

    Webhook-gebruikersinterface

    De juiste JSON retourneert het antwoord met de overeenkomst-ID.

    Webhook-gebruikersinterface

  1. Meld u aan bij Adobe Sign.

  2. Ga naar Account > Adobe Sign-API > API-informatie en klik op REST-API-methode - Documentatie.

    Fnord.

  3. Gebruik POST /transientDocuments, upload een bestand en maak een id voor een tijdelijk document.

  4. Kopieer de id voor het tijdelijke document en gebruik deze in de POST /agreement-methode. Vermeld de volgende JSON-aanvraag in het vak:

    { 
    "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. Klik op de knop Probeer het uit om de JSON-aanvraag uit te voeren.

    Fnord.

    De juiste JSON retourneert het antwoord met de overeenkomst-ID.

    Fnord.

  6. Als u de overeenkomst wilt openen in de ontwerpmodus, kopieert u de URL en plakt u deze in de adresbalk van een browser.

  7. Sleep de formuliervelden naar de gewenste locatie.

  8. Klik op Verzenden om de overeenkomst ter ondertekening te verzenden. 

Gebruik POST /agreements om een overeenkomst te maken. Hiermee wordt de overeenkomst ter ondertekening verzonden en wordt de agreementID in de reactie aan de client geretourneerd. Hieronder staat de benodigde JSON-indeling waarmee u een overeenkomst verzendt met de telefonische verificatiemethode.

 

{

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

}

}

 

Met de volgende methoden kunt u de gegevens rechtstreeks in de formuliervelden samenvoegen:

  • Een bibliotheeksjabloon gebruiken:

    als u een bibliotheeksjabloon-ID gebruikt onder de parameter FileInfo, zorg er dan voor dat u de exacte veldnaam en de bijbehorende gegevens opgeeft in de onderstaande sectie:

 

"mergeFieldInfo": [

     {

       "defaultValue": "",

       "fieldName": ""

     }

   ],

 

  • Tekstlabels gebruiken in een document dat is geüpload als een tijdelijk document:

    Als u een document uploadt waaraan tekstlabels zijn toegevoegd als een tijdelijk document, zorg er dan voor dat u de exacte veldnaam en de bijbehorende gegevens opgeeft in het onderstaande gedeelte: 

 

"mergeFieldInfo": [

     {

       "defaultValue": "",

       "fieldName": ""

     }

   ],

 

Hoe verzend ik een overeenkomst via een API met vooraf ingevulde waarden voor de specifieke formuliervelden (mergefield)?

Een voorwaarde voor deze aanroep is om eerst de stap 'Transient Upload' (Tijdelijk bestand uploaden) te voltooien en een "transientDocumentId" te verkrijgen die u hier wilt gebruiken (met: ecure.na1.echosign.com/public/docs/restapi/v5#!/transientDocuments/createTransientDocument).

  • Deze aanroep bevat de sectie 'mergeFieldInfo' waar standaardwaarden voor specifieke formuliervelden worden opgegeven.
  • Dit vult de gegevens van een ander systeem vooraf in bij de API-aanroep.
  • Deze velden in de overeenkomst zijn ofwel bewerkbaar of alleen-lezen.

 

Vereisten vooraf:

  1. Id van tijdelijk document
  2. Veldnamen en hun waarden

 

Voorbeeldaanvraag:

 

Aanvraag:

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

Host: api.na1.echosign.com (of u kunt uw shard-naam specificeren, te vinden met de aanroep getbaseURis: https://secure.na1.echosign.com/public/docs/restapi/v5#!/base_uris/getBaseUris

Toegangstoken: 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": "Please Sign this from us!",

       "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"

            }

        ]

   }

 

}

 

De reactie op deze aanroep is de 'agreementId' die u in uw systeem moet opslaan voor volgende aanroepen (signingUrl, status, formData enz.)

 

Reactie:

{

  "agreementId": "3AAABLblqZhCf_7xDcrOgKFwAabp1S-OFfvUdHf2wJsSMwlB95_x_WdUeab67jOkJi1IJzWuSJ0zdNNKugS1blZB4LT5vNVyJ"

}

 

Tijdens het uitvoeren van de methode 'post /megaSigns /{megaSignId}/views' wordt een fout weergegeven zoals: 'Aangevraagde weergave is niet beschikbaar voor de bron in de huidige staat.'

De fout treedt op als de opgegeven parameterwaarde voor de naam ongeldig is in de onderstaande aanvraagcode:

{
  "name": " "
}

Als de MegaSign-overeenkomst bijvoorbeeld al IN_PROCESS is, wordt de genoemde foutmelding geactiveerd wanneer u de waarde AUTHORING opgeeft. Zorg ervoor dat de opgegeven waarde in overeenstemming is met de huidige staat van de overeenkomst.

Tijdens het uitvoeren van de methode 'put /megaSigns/{megaSignId}/state' wordt een fout weergegeven zoals 'Geen waarde opgegeven voor MegaSign-annuleringsinformatie.'

De fout wordt veroorzaakt wanneer de volgende parameter ontbreekt: 

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

In plaats van het minimale schema te gebruiken, klikt u op Volledig modelschema en geeft u de volledige aanvraagcode op om de API-aanroep uit te voeren. 

Om de status van de MegaSign-overeenkomst te wijzigen, gebruikt u put /megaSigns/{megaSignId}/state en voert u de volgende stappen uit:

  1. Ga naar REST-API-documentatie voor V6 en selecteer de methode
    put /megaSigns/{megaSignId}/state.
  2. Geef de autorisatiewaarde op en ook de If-Match en megasignID.
    • Gebruik get /megaSigns om megasignID op te halen
    • Om If-Match op te halen, gebruikt u get /megaSigns/{megaSignId} en zoekt u in de header naar 'Etag'
  3. {
      "state": "CANCELED",
      "megaSignCancellationInfo": {
       "comment": "cancel",
       "notifyOthers": false
      }
    } 

Voordat een webhook kan worden geregistreerd, moet de webhook-URL aan dit verzoek voldoen met een 2XX-reactiecode. Bovendien moet dezelfde waarde voor de client-id worden teruggestuurd op een van de volgende twee manieren:

  1. In de kop van de reactie X-AdobeSign-ClientId. Dit is dezelfde header die is doorgegeven in de oorspronkelijke aanvraag en die in de reactie moet worden 'teruggekaatst'.
  2. In de JSON-hoofdtekst van de reactie met de sleutel X-AdobeSign-ClientId en de waarde die gelijk is aan de client-id die in de koptekst van de aanvraag was verzonden.

Adobe Sign ontvangt de 2xx-reactie met X-AdobeSign-ClientId. De gebruiker kan controleren of deze al dan niet correct is geconfigureerd in de webhook.

De webhook-URL reageert niet zoals verwacht. Voor elke Post-melding die Adobe Sign heeft verzonden, antwoordt de URL met de 2XX-statuscode en wordt de client-id die is verzonden in aanvraagheaders (X-AdobeSign-ClientId), teruggekaatst in de koptekst van de reactie. 

Zie de volgende koppeling voor volledige informatie:
https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks/webhook_events.md

Als de URL niet voldoet aan dit protocol, gaat Adobe Sign ervan uit dat de aanvraag niet is erkend en wordt de aanvraag opnieuw ingepland volgens het betrouwbaarheidsbeleid.

Als de webhook niet reageert en de maximale tijd (of het maximale interval) voor opnieuw proberen wordt overschreden, wordt de webhook uitgeschakeld.

Dit werk is in licentie gegeven onder een Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported-licentie  Twitter™- en Facebook-berichten vallen niet onder de voorwaarden van Creative Co


Informatie over overeenkomsten beheren/verkrijgen

Als u het document wilt wijzigen dat al ter ondertekening is verzonden, gebruikt u de methode PUT /agreements/{agreementId} waarmee u een bestaande overeenkomst kunt bijwerken. Geef de tijdelijke id samen met de overeenkomst-id op in de volgende aanvraagcode:

 

{

  "documentUpdateInfo": {

    "fileInfos": [

      {

        "agreementDocumentId": "",

        "transientDocumentId": ""

      }

    ]

  }

}

 

Hieronder vindt u instructies over het bijwerken van de status van "AUTHORING" naar "IN_PROCESS" met Put /agreements/{agreementId}/state:

  1. Haal de overeenkomst-id op met de POST /Agreement-methode.

  2. Gebruik Get /agreements/{agreementId} om de nieuwste ETag op te halen.

  3. Ga naar Put /agreements/{agreementId}/state en geef de volgende informatie op: "state": "IN_PROCESS"

Nee.

De huidige REST-API biedt geen methode om een ondertekende kopie te uploaden.

De afzender moet de ondertekende kopie uploaden vanaf de pagina Beheren.

DELETE /agreements/ID wordt gebruikt om een overeenkomst te verbergen op de pagina Beheren.

Met de nieuwe PUT /agreements/ID/me/visibility API van Adobe kan de zichtbaarheid van overeenkomsten worden bepaald (in GET /agreements). Naast de functionaliteit die wordt geboden door DELETE /agreements/ID kan de gebruiker met het nieuwe zichtbaarheidseindpunt ook een verbergingsbewerking ongedaan maken en de overeenkomst weer zichtbaar maken. 

U kunt ook de onderstaande gedetailleerde stappen volgen:

  1. Ga naar de methode get /agreements en haal de overeenkomst-ID op.
  2. Klik op put /agreements/{agreementId}/me/visibility en geef de volgende aanvraag als voorbeeld:
    {
      "visibility": "HIDE"
    }
    De overeenkomst-ID is alleen verborgen bij get /libraryDocuments, maar nog wel zichtbaar op het tabblad Beheer van de gebruikersinterface.
Opmerking:

De functie API-retentie is niet standaard ingeschakeld.

Als u de bewerking DELETE/agreements wilt inschakelen, neemt u contact op met uw succesmanager en vraagt u om API-retentie in te schakelen voor het account.

Raadpleeg Adobe Sign - Documentretentie voor meer informatie over het inschakelen van de retentiefuncties voor uw account.

  1. Meld u aan als Adobe Sign-beheerder en ga naar: https://secure.adobesign.com/public/docs/restapi/v6

    • Klik op agreements en vouw de methode GET /agreements uit
    • Klik op de knop OAUTH ACCESS-TOKEN. 
    • Schakel het bereik agreement_read:self in.
    • Klik op de knop Autoriseren
      • Klik op Toegang verlenen als u hierom wordt gevraagd
    • Klik op de knop Probeer het uit!
    De Get agreement-methode

  3. De reactie wordt gegenereerd.

    De agreementId is te vinden in de hoofdtekst van de reactie:

    Reactie voor Get agreement

  4. DELETE /agreements/{agreementId}/documents: Verwijdert alle documenten die betrekking hebben op een overeenkomst. De overeenkomst zelf blijft zichtbaar op de pagina Beheren.

    • Selecteer de DELETE/agreements-bewerking die moet worden uitgevoerd.
    • Klik op de knop OAUTH ACCESS-TOKEN en maak een toegangstoken met het juiste bereik voor agreement_retention.
    • Geef de agreementId op voor de overeenkomst die u wilt verwijderen.
    • Zodra de overeenkomst is verwijderd, heeft de hoofdtekst van de reactie 'geen inhoud'.

U krijgt het volgende antwoord als de bewerking DELETE/agreements niet is ingeschakeld:

 "code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",

  "message": "Voor deze bewerking moeten enkele accountinstellingen worden ingeschakeld. Neem contact op met het Adobe Sign-team om de instellingen in te schakelen. "

Hoe kunt u het ondertekende document samen met het auditrapport en het ondersteuningsdocument downloaden via de Adobe Sign REST-API, in plaats van een afzonderlijke aanroep uit te voeren om het auditrapport te downloaden? Gebruik hiervoor de volgende methode:

GET /agreements/{agreementId}/auditTrail

  1. Ga naar https://secure.na1.adobesign.com/public/docs/restapi/v5.

  2. Klik op GET /agreements/{agreementId}/combinedDocument.

  3. Klik op de knop oAuth Access-token.

  4. Toegangstoken wordt automatisch gegenereerd zodra de autorisatie is geaccepteerd.

  5. Geef de agreementId op.

  6. Selecteer 'true' onder attachSupportingDocuments in de vervolgkeuzelijst.

  7. Selecteer 'true' onder attachAuditReport in de vervolgkeuzelijst.

  8. Klik op de knop Probeer het uit! 

    Gecombineerde documenten ophalen

    Hiermee downloadt u de gecombineerde PDF met daarin het ondertekende document, het ondersteuningsdocument en het auditrapport.

Om bulkdocumenten te downloaden, is alleen de tool voor het exporteren van documenten beschikbaar en met de API kunt u documenten alleen individueel (een voor een) downloaden. Hieronder volgt de API-methode:

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


Bibliotheeksjablonen en webformulieren

  1. Meld u aan bij Adobe Sign als beheerder en ga naar: https://secure.na1.adobesign.com/public/docs/restapi/v6

    • Klik op libraryDocuments en vouw de methode GET /libraryDocuments uit
    • Klik op de knop OAUTH ACCESS-TOKEN. 
    • Schakel het bereik library_read:self in
    • Klik op de knop Autoriseren
      • Klik op Toegang verlenen als u hierom wordt gevraagd
    • Klik op de knop Probeer het uit!
    De Get LibraryDocument-methode

  3. De reactie wordt gegenereerd.

    De libraryDocumentId is te vinden in de hoofdtekst van de reactie:

    Get LibraryDocument Response

Met de nieuwe PUT/libraryDocuments/ID/me/visibility-API van Adobe kan de zichtbaarheid van een bibliotheekdocument worden bepaald (in GET /agreements). Naast de functionaliteit die wordt geboden door DELETE /agreements/ID kan de gebruiker met het nieuwe zichtbaarheidseindpunt ook een verbergingsbewerking ongedaan maken en de overeenkomst weer zichtbaar maken.

Volg de onderstaande gedetailleerde stappen:

  1. Ga naar de methode get /libraryDocuments en haal de overeenkomst-id op.
  2. Klik op put /libraryDocuments/{libraryDocumentId}/me/visibility en geef de volgende aanvraag op als voorbeeld:
    {
      "visibility": "HIDE"
    }
    De bibliotheek-ID is alleen verborgen bij get /libraryDocuments, maar nog wel zichtbaar op het tabblad Beheer van de gebruikersinterface.
Opmerking:
  • Dien een verzoek in bij het ondersteuningsteam om het bereik in te schakelen voor het verwijderen van de bibliotheek.
  • Het bibliotheekdocument wordt door de API verwijderd. Dit is echter niet van invloed op de overeenkomsten die met dit bibliotheekdocument zijn gemaakt.


Een libraryDocumentID maken

  1. Ga naar https://secure.echosign.com/public/docs/restapi/v5.

  2. Klik op libraryDocuments.

  3. Klik op de knop oAuth Access-token. 

    Autoriseren - Toegangstoken voor uzelf, groep of account.

  4. libraryTemplateType selecteren - Document of Form_field_layer.

  5. Klik op Probeer het uit.

    U kunt de volgende reactie voor al uw sjablonen ontvangen. (Kopieer libraryDocumentId voor de bibliotheeksjabloon die u wilt verwijderen).

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


Bibliotheeksjablonen verwijderen

  1. Kopieer libraryDocumentID vanuit de hoofdtekst van de reactie.

  2. Ga naar Delete libraryDocuments (Verwijderen>bibliotheekdocumenten).

  3. Klik op de knop oAuth Access-token. Toegang autoriseren - Token voor uzelf, groep of account.

  4. Plak de libraryDocumentId in het waardeveld.

  5. Klik op Probeer het uit. 
    De sjabloon is verwijderd.

    U krijgt de volgende reactiecode: 204

Opmerking:

Alleen webformulieren met de conceptstatus kunnen worden bijgewerkt.

  1. Maak de widget met behulp van post /widgets.

  2. Haal de widget-id op via get /widgets.

  3. Eenmaal gemaakt met behulp van de GET /widgets/{widgetId}-methode, haalt u de Etag op uit de koptekst van de reactie.

    Foo

  4. Gebruik de Etag die u hebt opgehaald van GET /widgets/{widgetId} onder PUT /widgets/{widgetId}. Voer widgetId en widgetInfo in onder de parameter If-Match.

    Foo 

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


Voorbeelden van gebruiksscenario's

  1. Maak een GET /agreements-aanroep met de juiste x-api-user.

  2. Zoek in de hoofdtekst van de reactie naar de overeenkomst met de status Uit voor ondertekening en waarvoor u de ondertekenings-URL wilt vinden. Noteer de overeenkomst-id

  3. Voer een GET /agreements/{agreementId}/signingUrls-aanroep uit met behulp van de overeenkomst-id die u hebt ontvangen via de GET /agreements-aanroep.

     

    Resultaat

    De uitvoer retourneert het e-mailadres van de ondertekenaar(s) en de URL voor elektronische ondertekening.

    De GET agreement-methode

 Adobe

Krijg sneller en gemakkelijker hulp

Nieuwe gebruiker?

Snelle koppelingen

Al je lidmaatschappen weergeven Je lidmaatschappen beheren
Snelle koppelingen weergeven
Snelle koppelingen verbergen

Juridische kennisgevingen    |    Online privacybeleid