Technische accounts maken om overeenkomsten te verzenden via API

Laatst bijgewerkt op 1 dec. 2023

Technische accounts voor Adobe Acrobat Sign

Technische accounts voor Acrobat Sign zijn een middel waarmee accounts op bedrijfsniveau hun applicaties kunnen uitvoeren onder autoriteit van een userID die expliciet voor dat doel is gegenereerd (versus het gebruik van de persoonlijke userID van de beheerder).

Technische accounts zijn beschikbaar voor zakelijke klanten (via Adobe Developers Console) op het ETLA-aankoopplan dat hun account beheert via Adobe Admin Console.

De productkaart voor toegang tot technische accounts is te vinden op het tabblad Producten van de Admin Console onder de aanbiedingsnaam Adobe Acrobat Sign Solutions - Enterprise (zoek naar de markering API beschikbaar):

Productkaarten voor technische accounts

Notitie

Het onderstaande proces beschrijft het gebruik van technische accounts via een API-oplossing. Organisaties die gebruikers in staat willen stellen om namens een gecentraliseerde partij handmatig overeenkomsten te verzenden, verwijzen naar het document voor het instellen van technische accounts via handmatige verbinding.

Vereisten

Om een technisch account in te schakelen moet uw Acrobat Sign-account aan het volgende voldoen:

  • ETLA-service op bedrijfsniveau hebben
  • Gebruikers beheren op de Adobe Admin Console*
  • Geavanceerd account delen moet zijn ingeschakeld

*Een opmerking over de Adobe Admin Console

De Adobe Admin Console biedt een kader voor gebruikersbeheer en licentietoewijzing. De meeste klanten hebben slechts één Admin Console.

Sommige klanten met complexe gebruikers-/licentievereisten kunnen echter meerdere Admin Consoles hebben, wat verwarrend kan zijn in een proces zoals het maken van een technisch account, waarbij één Admin Console het federatieve gebruikersbeheer kan regelen en een andere de Acrobat Sign-licentie beheert.

Als u weet dat u meerdere accounts hebt of er niet zeker van bent, lees dan het onderstaande:

De moeilijkheid met meerdere Admin Consoles is dat u in de juiste console moet zijn voor de acties die u probeert uit te voeren.

Bepalen of u meerdere Admin Consoles hebt:

1. Meld u aan bij Admin Console.

2. Klik in de rechterbovenhoek van de console op de naam van de organisatie.

Als u een vervolgkeuzemenu hebt met meerdere organisaties, hebt u meerdere Admin Consoles.

Vervolgkeuzemenu Admin Console-organisatie

Als u slechts één Admin Console hebt, worden in dezelfde organisatie gebruikers gemaakt en licenties verleend en hoeft u zich geen zorgen te maken over het wisselen tussen consoles.

Als u meerdere Admin Consoles hebt, neem dan even de tijd om te bepalen welke organisatie het maken van federatieve gebruikers beheert en welke de licentiebepaling voor Acrobat Sign beheert.

Bedrijven met meerdere Admin Consoles kunnen Acrobat Sign vanaf meer dan één systeem implementeren. U moet de Admin Console identificeren waar u de API-verbinding en de gebruiker van het technische account wilt instellen.

U moet elke organisatie inspecteren om te bepalen welke het technische account moet bevatten.

  1. Selecteer de organisatie.
  2. Selecteer Producten in de bovenste rail met opties.
  3. Zoek naar de Adobe Sign - Enterprise-productkaart met de markering API beschikbaar.

Voor het doel van dit document noemen we dit uw Licensing Admin Console. Dit is de organisatie waar:

  • U de beheerder of ontwikkelaar definieert die de API zal verbinden.
  • Uw technische accountgebruiker wordt gemaakt en beheerd.
Productkaarten voor technische accounts

Organisaties die federatief gebruikersbeheer hebben, moeten de federatieve oplossing desynchroniseren om een gebruiker buiten de federatieve omgeving te maken.

Daarvoor moet u elke organisatie inspecteren om te bepalen welke de domeinen beheert die de federatieve vertrouwensrelatie mogelijk maken. Meerdere Admin Consoles kunnen een domein vertrouwen, maar slechts één beheert het actief.

  1. Organisatie selecteren
  2. Selecteer instellingen in de bovenste rail met opties.
  3. Selecteer Identiteit in de linkerrail met opties.
  4. Als er mappen worden vermeld met het Type Federated ID en de Status Vertrouwd, klikt u op de rij waarin de map zich bevindt om de eigenaar van de organisatie weer te geven.
Naar Identiteit

De eigenaarorganisatie is de juiste Admin Console om uw federatieve ID-synchronisatiebesturingselementen te manipuleren.

  • Er wordt een e-mail verstrekt voor de consolebeheerder als u momenteel geen toegang hebt.

Als het Type Federated ID en de Status Actief, klikt u op de Naam van de map om de mapinstellingen te openen.

Actief domein

Selecteer op de pagina Instellingen het tabblad Synchroniseren, waarmee de IDP-synchronisatiegegevens worden geopend.

Voor het doel van dit document wordt dit uw Federated Sync Admin Console genoemd.

Directory-instellingen - tabblad Synchroniseren

Notitie

Als u geen tabblad Synchroniseren ziet, heeft uw account mogelijk een Global Admin Console waartoe u geen toegang hebt.

U dient contact op te nemen met uw interne Adobe-beheerders om toegang te krijgen.

Organisaties die

  • de gebruikerssynchronisatietool (UST) gebruiken om gebruikers automatisch te synchroniseren tussen Adobe en hun Active Directory,
  • staan niet toe dat gebruikers handmatig worden toegevoegd of gemaakt in Acrobat Sign  

moet een uitzonderingengroep maken voor alle userID's van technische accounts. Voor alle userID's van technische accounts moet de primaire groep zijn gedefinieerd als de vrijgestelde groep om ervoor te zorgen dat ze niet worden gedeactiveerd en dat hun licentie niet wordt verwijderd door de automatische gebruikerssynchronisatie.

De uitzonderingengroep moet worden geconfigureerd als vrijgesteld van de synchronisatie binnen de UST-configuratie.

In gevallen waarin Adobe de UST host namens de organisatie van de klant, moet de klantbeheerder de Groepsnaam doorgeven aan hun succesmanager, technische accountmanager of accountvertegenwoordiger, zodat ze kunnen werken met het Adobe-Customer Solutions-team om ervoor te zorgen dat deze groep is vrijgesteld van de synchronisatie.

Overzicht

Het maken van een technisch account is een proces dat uit meerdere stappen bestaat en waarvoor toegang op beheerdersniveau tot de Adobe Acrobat Console en beheerdersrechten op accountniveau in Acrobat Sign vereist zijn.

Het proces vereist van de beheerder het volgende:

  1. Schakel beheerders- of ontwikkelaarstoegang in voor de gebruiker die het technische account maakt.
    • De gebruiker moet een beheerder of ontwikkelaar zijn om de instellingen te configureren voor het maken van het technische account.
  2. Een nieuw project maken in de Adobe Developer Console (Adobe.io).
    • Het project is de vereiste omgeving om het openbare/privésleutelpaar en het toegangstoken te bevatten dat de functionaliteit van het technische account mogelijk maakt.
  3. Een openbaar/privésleutelpaar maken of uploaden en een toegangstoken genereren.
    • Als u het toegangstoken genereert, wordt de userID van het technische account in de Adobe Admin Console gemaakt en in het Acrobat Sign-systeem ingevuld.
  4. (Optioneel) Een nieuwe groep maken in het Acrobat Sign-systeem.
    • Door een speciale groep te maken voor het userID van het technische account is een zeer strakke configuratie van de overeenkomsteigenschappen mogelijk, die mogelijk te strikt is of afwijkt van andere groepsconfiguraties.
  5. De userID van het technische account in Acrobat Sign machtigen als beheerder op groepsniveau.
  6. Een nieuwe federatieve gebruiker maken in Adobe Admin Console.
    • Hiermee wordt een e-mailadres van een gebruiker gemaakt met uw domein als proxy voor de gebruikers-ID van het technische account bij het verzenden, waarbij een e-mailadres wordt opgegeven dat correct is toegewezen aan uw bedrijf.
  7. Deel het account van de federatieve gebruiker met het technische account.
    • De gebruikers-ID van het technische account wordt gegenereerd in de Licensing Admin Console met een e-mailadres van adobe.com. Door het account van de federatieve gebruiker te delen geeft u toegang tot de gebruikers-ID van het technische account om namens de Federated UserID te verzenden, waardoor een mensvriendelijkere naam/e-mailadres voor de ontvangers wordt verstrekt.

    Wanneer dit is voltooid, kan de API worden geconfigureerd om het technische account (via toegangscode) te gebruiken om overeenkomsten te maken en te verzenden namens een gecentraliseerde gebruiker.

Gebruikers toegang geven tot de Developers Console

Voordat u een nieuw technisch account kunt toevoegen, moet de gebruiker eerst worden toegevoegd aan het Adobe Acrobat Sign Solutions - Enterprise-productprofiel (in uw Licensing Admin Console) als beheerder of ontwikkelaar.

  1. Klik op de koppeling Adobe Acrobat Sign Solutions - Enterprise in de linkerrail of producten.

  2. Selecteer het standaard productprofiel voor de Acrobat Sign-service.

    Productprofiel selecteren

  3. De pagina Gebruikers aan dit product toevoegen wordt geopend:

    • Selecteer het tabblad Beheerder of Ontwikkelaar.
  4. Voer het e-mailadres in van de gebruiker aan wie u toegang wilt verlenen.

  5. Klik op Beheerder toevoegen/Ontwikkelaar.

    Ontwikkelaar toevoegen

  6. Voer het e-mailadres in van de gebruiker aan wie u toegang wilt verlenen.

  7. Voer de voor- en achternaam in.

  8. Klik op Opslaan wanneer u klaar bent.

    Informatie van de ontwikkelaar invoeren

Een nieuw project maken op de Adobe.io-console

  1. Ga naar https://console.adobe.io

    • Als u lid bent van meerdere Admin Console-instanties, zorg er dan voor dat u bent verbonden met de instantie die is uitgelijnd met uw Licensing Admin Console door op de pijl-omlaag in de rechterbovenhoek van het venster te klikken.
    Admin Console-instanties

  2. Selecteer Nieuw project maken.

    Een nieuw project maken

  3. Het nieuwe project wordt weergegeven op het tabblad Projecten van de console.

    Neem even de tijd om uw project een naam te geven door op de knop Project bewerken te klikken.

    • Geef een naam op die uw collega 's zullen begrijpen
    • Geef een korte beschrijving
    • Sla de bewerkingen op
    Het project bewerken

  4. Selecteer het nieuwe project (op het tabblad Projecten) om het te openen voor configuratie.

    Op de pagina Aan de slag:

    1. Selecteer Toevoegen aan project
    2. Selecteer API in de vervolgkeuzelijst
    API toevoegen

  5. Op de pagina Een API toevoegen:

    1. Selecteer het filter Documentcloud
    2. Selecteer Acrobat Sign
    3. Klik op Volgende.
    Selecteer Acrobat Sign

Een nieuw JSON-webtoken maken

U hebt de mogelijkheid om een nieuw openbaar/privésleutelpaar te genereren of om uw openbare sleutel te uploaden. Kies de optie die het beste bij uw wensen past:

  1. Selecteer Sleutelpaar genereren.

  2. Klik op Sleutelpaar genereren.

    Sleutelpaar genereren

  3. Zodra het sleutelpaar is gemaakt, wordt u gevraagd de privésleutel op te slaan in uw lokale systeem.

    De openbare sleutel kan worden gekopieerd vanuit de interface:

    Openbare sleutel

  4. Selecteer Volgende.

  1. Selecteer Uw openbare sleutel uploaden.

  2. Sleep uw openbare sleutelcertificaat naar het uploadveld.

  3. Selecteer Volgende.

    Uw openbare sleutel uploaden

    Uw geüploade openbare sleutel wordt weergegeven op de pagina API configureren. U kunt het vanaf hier kopiëren.

    U kunt extra sleutels uploaden of zo nodig nieuwe sleutels genereren.

  4. Selecteer Volgende wanneer al uw sleutels zijn toegevoegd.

Het productprofiel selecteren

De pagina API configureren wordt vernieuwd om de productprofielen weer te geven die beschikbaar zijn voor uw account. Mogelijk hebt u er een of meer, afhankelijk van de profielen die beschikbaar zijn voor uw account.

  1. Schakel het selectievakje in voor uw standaard Adobe Acrobat Sign Solutions - Enterprise.
  2. Selecteer Geconfigureerde API opslaan wanneer u klaar bent.
Geconfigureerde API opslaan

Een toegangstoken genereren

Eenmaal opgeslagen wordt het technische account gemaakt en keert u terug naar de startpagina van het project.

In het gedeelte Toegangstoken genereren is er een invoerveld voor uw privésleutel.

  1. Plak de privésleutel die u eerder hebt gegenereerd/geüpload in het veld Privésleutel.

  2. Selecteer Token genereren.

  3. Even later wordt het veld Privésleutel vernieuwd om het Toegangstoken weer te geven.

  4. Kopieer het toegangstoken en sla het op.

    Het toegangstoken genereren

  5. Lager op dezelfde pagina hebt u toegang tot het volgende:

    • Klant-ID
    • Klantgeheim
    • Technisch Account-ID
    • E-mailadres technisch account
    • Organisatie-ID

    Kopieer het E-mailadres van het technische account en sla het op.

    Het e-mailadres van het technische account opslaan

  1. Stel in het bestand config.properties de technische accountgegevens in:

    • Apikey
    • Technicalaccountid
    • Orgid
    • Secret
    • expirationTime
    • metascopes
    • key_path
    • imshost
    • imsExchange
  2. Sla de secret.key op in DER-formaat in de doelmap.

Overweeg het genereren van een unieke groep in Acrobat Sign voor de toepassing

Voor Acrobat Sign-groepen is een gedetailleerde configuratie van de beveiligings- en ervaringsinstellingen voor de ontvanger mogelijk (evenals workflows, sjablonen, rapportage, enz.)

Als u de userID van het technische account in hun eigen groep wilt isoleren:

  1. Meld u aan bij Acrobat Sign als beheerder op accountniveau.

  2. Ga naar het tabblad Groepen in het beheerdersmenu.

  3. Klik op het plusteken om een nieuwe groep te maken.

  4. Voer een intuïtieve naam in voor de groep (misschien dezelfde naam als het project).

  5. Sla de groep op.

  6. (Optioneel) Open de nieuwe groep en configureer de instellingen die nodig zijn voor de applicatie.

    Een groep maken

Notitie

Als uw organisatie

  • de gebruikerssynchronisatietool (UST) gebruikt om gebruikers automatisch te synchroniseren tussen Adobe en uw Active Directory,
  • en gebruikers niet handmatig mogen worden toegevoegd of gemaakt in Acrobat Sign,

U moet een uitzonderingsgroep die fungeert als de primaire groep voor alle userID's van technische accounts.

De naam van de groep wordt toegevoegd aan uw UST-configuratie om te voorkomen dat het synchronisatieproces invloed heeft op de userID's, wat ertoe zou kunnen leiden dat ze worden gedeactiveerd of dat hun rechten worden verwijderd.

De userID van het technische account machtigen als groepsbeheerder in Acrobat Sign

Wacht enkele minuten totdat de nieuwe gebruiker techacct.adobe.com wordt gegenereerd in het Acrobat Sign-systeem.

  1. Meld u aan bij uw Acrobat Sign-account als beheerder op accountniveau.

  2. Ga naar het tabblad Gebruikers in het beheerdersmenu.

  3. Zoek naar het nieuwe e-mailadres techacct.adobe.com (gekopieerd van de startpagina van het project).

  4. Klik op de gebruiker en selecteer Gebruikersgegevens bewerken.

    Gebruikersgegevens bewerken

  5. Klik op het pluspictogram in het gedeelte Groepslidmaatschap en voeg de groep van de applicatie toe aan het profiel van de gebruiker.

  6. Selecteer de groep van de applicatie en klik op de koppeling Markeren als primaire koppeling.

  7. Schakel het selectievakje in om de userID als een groepsbeheerder te markeren.

  8. (Optioneel) Verwijder het technische account uit de groep Standaard.

  9. Klik op Opslaan wanneer u klaar bent.

    De gebruikersinstellingen opslaan

Een Antwoorden aan-gebruiker/e-mail maken

Het verzenden van overeenkomsten met de userID/e-mail die aan het technische account is gekoppeld, is problematisch omdat de e-mail niet binnen uw bedrijfsdomein valt.

U kunt dit probleem als volgt oplossen:

  • Er moet een nieuwe federatieve userID worden gemaakt in de Licensing Admin Console.
  • De technische userID van het account moet worden gedeeld met de nieuwe federatieve userID (via geavanceerd delen van accounts).

Eenmaal geconfigureerd moeten de API-aanroepen worden geconfigureerd om de technische accounttoken te gebruiken als de Autorisatie-waarde, en de userID of het e-mailadres van de gedeelde userID als de x-namens-de-gebruiker-waarde.

Een nieuwe federatieve userID maken

Voordat u de nieuwe userID maakt, moet u een e-mailadres opgeven dat kan worden gebruikt voor binnenkomende antwoorden/vragen van uw ontvangers.

Nieuwe userID maken:

  1. Meld u als beheerder aan bij uw (Federated Sync) Admin Console.

  2. Ga naar: InstellingenIdentiteit

    Selecteer een directory om de nieuwe gebruiker te maken.

    Actief domein

  3. Selecteer het tabblad Synchronisatie.

  4. Selecteer Ga naar instellingen en klik op Bewerken inschakelen.

    Wanneer bewerken is ingeschakeld, kunt u met uw Adobe Admin Console alleen de gebruikersgegevens in de Admin Console bewerken. Uw IdP is niet bijgewerkt met de bewerkingen.

    Directory-instellingen - tabblad Synchroniseren

    Notitie

    Bewerken blijft slechts één uur ingeschakeld, of totdat het handmatig wordt uitgeschakeld.

    Technisch account

  5. Meld u aan bij uw Licensing Admin Console (als u met meerdere Admin Consoles werkt).

  6. Ga naar: Gebruikers → Gebruiker toevoegen.

  7. Configureer uw nieuwe userID met:

    • E-mailadres of gebruikersnaam: gebruik het e-mailadres waarmee u eventuele antwoorden van uw ontvangers wilt vastleggen.
    • ID-type: Federated ID
    • Voor-/achternaam: deze waarde wordt gebruikt in het Acrobat Sign-systeem en wordt weergegeven in het controlerapport. Gebruik een waarde die context biedt. bijv.: Human Resources
    • SSO-gebruikersnaam: gebruik dezelfde e-mailwaarde.
    • Land/regio: selecteer het juiste land of regio voor uw bedrijf.
    • Selecteer het Acrobat Sign-product/profiel waaraan de technische userID is gekoppeld.
    • Stel de gebruikersrol in op Gebruiker.

    Klik op Opslaan als u gereed bent.

    Technisch account

  8. Meld u opnieuw aan bij de Federated Sync Admin Console om het synchroniseren van uw IdP-gegevens in te schakelen.

  9. Ga terug naar Instellingen → Identiteit → {Directory} → Synchronisatie → Ga naar instellingen.

    Klik op Bewerken uitschakelen om de synchronisatie van gegevens met uw IdP opnieuw in te schakelen.

  10. Uw nieuwe userID wordt automatisch gegenereerd in het Acrobat Sign-systeem.

Het technische account delen met de nieuwe federatieve userID

Toegang tot de content voor een userID waarop u zich kunt aanmelden:

  1. Meld u aan bij Acrobat Sign als accountbeheerder.

  2. Ga naar het tabblad Gebruikers in het beheerdersmenu.

  3. Klik één keer op de nieuwe gebruiker en vervolgens op Gebruikersgegevens bewerken.

  4. Selecteer Status delen in het linkermenu.

    Zorg ervoor dat het tabblad Gebruikersaccount gedeeld met is geselecteerd.

  5. Selecteer het tabblad Gedeeld met gebruiker boven aan de pagina Status delen.

  6. Het account van de nieuwe userID delen met het technische account

    1. Klik op het pluspictogram in de rij rechtsboven om de selectie-interface te openen.
    2. Klik op het pictogram met de drie regels rechts van het zoekvak.
    3. Vouw de groep uit waar de userID van het technische account zich bevindt.
    4. Klik op het pluspictogram naast de userID van het technische account om deze te selecteren.
    5. Selecteer Aanvullende toestemming om Verzenden toe te staan.
    6. Klik op Opslaan.
    Technisch account

Uw nieuwe technische account testen

Testen of uw toegangscode correct werkt:

  1. Selecteer de methode GET /users.

  2. In het veld Autorisatie:

    1. Typ het woord Bearer gevolgd door een spatie
    2. Plak de Toegangscode
    3. Klik op Probeer het uit!
    Probeer het uit!

  3. De antwoordhoofdtekst retourneert een lijst van de gebruikers in het account en een Antwoordcode van 200:

    Antwoordhoofdtekst

  1. Selecteer de methode POST /users/{userId}/views.

  2. In het veld Autorisatie:

    1. Typ het woord Bearer gevolgd door een spatie.
    2. Plak de toegangscode.
  3. In het veld userID voert u ik in.

  4. Klik op de koppeling Volledig modelschema.

  5. Klik in het gele veld om het schema over te zetten naar het veld UserViewInfo.

  6. Het veld UserViewInfo bewerken:

    • Als naamwaarde voert u ALL in.
    • Wijzig de waarde voor autoLoginUser naar true.
  7. Klik op Probeer het uit!

    API configureren voor toegangstoken

    Het veld voor de geretourneerde Antwoordhoofdtekst bevat de URL die nodig is om u als gebruiker aan te melden:

    Toegangs-URL kopiëren

  8. Kopieer de URL en plak deze in een browser.

  9. U wordt gevraagd om de aanmelding te bevestigen.

    Klik op Ja.

    Bevestig de aanmelding.

Verzending van een overeenkomst testen met behulp van het technische account namens de nieuwe userID via API

  1. Verkrijg een transientDocumentId of gebruik een andere methode om een bestand bij te voegen.

  2. In het veld Autorisatie:

    1. Voer het woord Drager in, gevolgd door een spatie
    2. Plak in het toegangstoken
      van het technische account
    3. Voer in het veld x-namens-gebruiker het e-mailadres in van de nieuwe gebruikers-ID
    4. Vul de rest van de AgreementInfo in met de transientDocumentId, de naam van de overeenkomst, het type handtekening en de status.
    5. Klik op Probeer het uit!
    Probeer het uit!

  3. Meld u aan bij Acrobat Sign als de nieuwe userID en ga naar het tabblad Beheren .

  4. Als u het controlelogboek van de overeenkomst bekijkt, ziet u dat de overeenkomst door het technische account is verzonden namens de nieuwe userID.

De content controleren die is gegenereerd namens de nieuwe userID via de Acrobat Sign-interface

Als het technische account een overeenkomst maakt namens de Federated userID, wordt de overeenkomst gepubliceerd op de pagina Beheren van de Federated userID.

U kunt de overeenkomst bekijken en beheren op de pagina Beheren van de Federated userID.

Overeenkomst verzonden namens de gebruiker