Web Analytics

Ondertekening van documenten op afstand met eSigner CSC API

Bekijk alle gidsen

In deze handleiding wordt uitgelegd hoe u een bestelling voor een certificaat voor ondertekening van documenten registreert bij SSL.com eSigner service en gebruik de Cloud Signature Consortium (CSC) API om een ​​document-hash en een pdf-bestand digitaal te ondertekenen. U kunt deze gids met beide gebruiken Krul or Postbode​ We raden Postman-gebruikers aan om het desktop-app voor het doornemen van de voorbeelden. De voorbeelden in deze handleiding zijn beide van toepassing op de productie- en testomgevingen van SSL.com voor eSigner en eSealing. Verschillen in commando's tussen productie- en testmodi worden in de volgende secties uitgelegd.

Om deze instructies te volgen heeft u nodig:

  • Een gevalideerde bestelling voor het ondertekenen van documenten. Gelieve te lezen deze how-to voor volledige instructies over bestellen en valideren.
  • A klant-ID (ook bekend als een Applicatie ID. Raadpleeg deze how-to voor instructies over het genereren van deze referentie).

Bestel uw SSL.com Document Signing Certificaat

U kunt dit gedeelte overslaan als u al een uitgegeven documentondertekeningscertificaat heeft. Als dit het geval is, ga dan verder naar het volgende gedeelte waarin wordt beschreven hoe u uw certificaat in eSigner kunt inschrijven.

Hoe u een certificaat bestelt in de productieomgeving

Raadpleeg dit gidsartikel voor instructies over het bestellen van een ondertekeningscertificaat voor productiedocumenten: Bestelproces voor certificaten voor code- en documentondertekening

Een testcertificaat bestellen op de Sandbox van SSL.com

Als u het aanmaken van een Sandbox-account en testbestelling wilt overslaan, kunt u de eSigner Sandbox ook proberen met een demo-account en certificaat. Gelieve te lezen Inloggegevens en certificaten voor eSigner-demo voor referenties en configuratie-informatie.
  1. Eerst moet u een documentondertekeningsopdracht aanmaken in de Sandbox. Begin door in te loggen op uw Sandbox-account en naar het Overzicht Tab.
    Sandbox-dashboard
  2. Klik ontwikkeltools.
    ontwikkeltools
  3. kies eSigner-documentondertekening, klik dan op de knop Testorder maken knop.
  4. Er verschijnt een dialoogvenster. Klik op de OK knop.
  5. Zoek uw testbestelling en klik op het gegevens link.
    detaillink
  6. Klik registrant bewerken om te beginnen met het invoeren van informatie over de aanvrager en ontvanger voor uw testbestelling. Merk op dat aangezien deze informatie niet zal worden gebruikt om een ​​geldig documentondertekeningscertificaat af te geven, u indien gewenst fictieve informatie kunt invoeren.
    registrant bewerken
  7. Voeg informatie over de aanvrager toe voor het testcertificaat en klik op het Volgende >> knop.
    Informatie voor aanvragers
  8. Voer de informatie van de ontvanger in en klik op het Volgende >> knop.
    informatie voor ontvanger
  9. Klik op de overslaan om het uploaden van validatiedocumenten voor het testcertificaat over te slaan.
    Skip-knop
  10. Uw testbestelling zou nu de status moeten hebben van in afwachting van goedkeuring. Neem contact op met het ondersteuningsteam van SSL.com op Support@SSL.com om uw testcertificaat te laten valideren.
    in afwachting van goedkeuring
Ga naar boven

Schrijf u in voor eSigner en stel twee-factorenauthenticatie in

  1. Voordat u de CSC API kunt gaan gebruiken, moet u zich inschrijven bij eSigner. Navigeer naar het Bestellingen tab in uw SSL.com-account in en zoek uw bestelling.
    Zoek bestelling
  2. Klik op de bestelling gegevens link.
    gegevens
  3. Maak een en bevestig een 4-cijferige pincode en klik op het PIN maken knop.
    Als u uw eSigner-pincode opnieuw moet instellen, lees dan a.u.b. deze how-to.
    Maak een pincode
  4. Er verschijnt een QR-code.
    De volgende keer dat u de pagina opnieuw laadt, is de QR-code niet zichtbaar. Als u uw eSigner QR-code moet bekijken of resetten, lees dan a.u.b. deze how-to.
    QR Code
  5. Scan de code in een 2-factor authenticatie-app op uw mobiele apparaat, zoals Google Authenticator or Authy​ De app geeft u eenmalige wachtwoorden (OTP's) die u kunt gebruiken bij het ondertekenen. Elke OTP is 30 seconden geldig.
    OTP in Authy
Tip: U kunt eSigner gebruiken om door de organisatie gevalideerde (OV) ondertekeningscertificaten te delen tussen teamgenoten. Gelieve te lezen Teamdeling voor eSigner-documenten en EV Code Signing-certificaten voor instructies.
Ga naar boven

Installeer Postman en importeer API-verzamelingen

De instructies in deze sectie zijn alleen voor Postman-gebruikers. Als u cURL gebruikt met de CSC API, kunt u naar de volgende sectie gaan.

  1. Download en pak het uit CSC API Postman-collectie en Document Signing API Postman-collectie (Zie https://www.postman.com/sslcom voor online SSL.com API-verzamelingen).
    Postbode-collecties
  2. Download en installeer de Postman REST-client.
    Postman REST Client downloaden
  3. Start Postman en maak vervolgens een nieuw Postman-account aan of log in op een bestaand account.
    Postbode Login
  4. Klik op de import knop.
    Importeer knop
  5. Klik op de Upload bestanden knop, navigeer naar de uitgepakte API-verzamelingsbestanden (csc-api-prod.postman_collection.json en document-signing-api-prod.postman_collection.json), en open ze.
    Upload bestanden
  6. Klik op de import knop.
    Klik op de importknop
  7. De API-verzoeken waarmee u gaat werken, zijn nu beschikbaar in het Collecties tab aan de linkerkant van het Postman-venster.
    API-verzoeken
Ga naar boven

Toegangstoken ophalen

De volgende stap is om een ​​toegangstoken op te halen bij SSL.com. Je hebt je klant-ID beschikbaar, evenals de gebruikersnaam en het wachtwoord voor uw SSL.com-account. Toegangstokens zijn één uur geldig nadat ze zijn uitgegeven.

Gebruik de klikbare tabbladen hieronder om instructies voor Postman of cURL te kiezen:

Postman instructiescURL-instructies
  1. Selecteer een API-verzoek uit de CSC API-collectie.
    selecteer API-verzoek
  2. Selecteer het autorisatie Tab en selecteer OAuth 2.0 van het Type menu.
    Autorisatie Tab
  3. Voer de volgende informatie in het formulier in:
    • Koptekstvoorvoegsel: Bearer
    • Token Naam: SSLCOM CSC (of een andere gemakkelijk te onthouden naam die u verkiest)
    • Soort subsidie: Authorization Code
    • Terugbel-URL: https://upload.esigner.com
    • Autoriseren via browser: ongehinderd
    • Verificatie-URL:  https://login.ssl.com/oauth2/authorize voor Productieomgeving; https://oauth-sandbox.ssl.com/oauth2/authorize voor Sandbox-omgeving.
    • Toegangstoken-URL: https://login.ssl.com/oauth2/token voor Productieomgeving; https://oauth-sandbox.ssl.com/oauth2/token voor Sandbox-omgeving. 
    • Klant identificatie: [Uw klant-ID]
    • Cliëntgeheim: [Uw klantgeheim]
    • Domein: service
    • Staat: [Leeg laten]
    • Clientverificatie: Send as Basic Auth header

    Als u klaar bent, klikt u op het Krijg een nieuw toegangstoken knop.
    Krijg een nieuw toegangstoken

  4. Er verschijnt een inlogformulier. Voer uw SSL.com gebruikersnaam en wachtwoord in en klik op het Leden knop.
    Account login
  5. Uw nieuwe toegangstoken zou in Postman moeten verschijnen. Selecteer de toegangstoken-tekst en kopieer deze naar het klembord en sluit het Beheer toegangstokens dialoog venster. Plak uw toegangstoken in een teksteditor waar u deze gemakkelijk kunt openen. Elk toegangstoken vervalt na een uur.
    U kunt uw token ook opslaan voor hergebruik in Postman-verzoeken, maar we hebben geconstateerd dat het het meest betrouwbaar is om het token rechtstreeks in elk verzoek te kopiëren en te plakken.
    Toegangstoken
  1. Gebruik de volgende opdracht om een ​​toegangstoken aan te vragen. Vervang de waarden die in HOOFDLETTERS worden weergegeven door uw werkelijke waarden:
    curl --location --request POST "https://login.ssl.com/oauth2/token" \ --header "Content-Type: application/json" \ --data-raw '{ "client_id" : "UW -CLIENT-ID", "client_secret" : "UW-KLANT-GEHEIM", "grant_type" : "password", "username" : "YOUR-USERNAME", "password" : "UW-WACHTWOORD" }'
  2. U zou een JSON-object moeten ontvangen met een toegangstoken en een vernieuwingstoken. Kopieer de waarde van het toegangstoken om in uw API-verzoeken te plakken. U hebt het vernieuwingstoken niet nodig voor deze voorbeelden.
    Toegangstoken ophalen
Ga naar boven

Teken een hash

Nu u een toegangstoken heeft, kunt u beginnen met het doen van API-verzoeken en het maken van handtekeningen. Dit gedeelte leidt u door de vijf beschikbare verzoeken in de Postman CSC-collectie, wat resulteert in het maken van een digitale handtekening op basis van een documenthash.

CSC-info opvragen (optioneel)

Postman instructiescURL-instructies
  1. U kunt gebruik maken van de CSC-info verzoek om informatie over de cloudhandtekeningservice van SSL.com. Merk op dat dit verzoek, in tegenstelling tot de andere in de collectie, uw toegangstoken niet vereist. Selecteer om het verzoek te verzenden CSC-info van het CSC-API verzameling en klik vervolgens op het Verzenden knop.
    Stuur CSC Info Request
  2. Informatie over de cloud-handtekeningservice wordt weergegeven in een JSON-object in Postman's antwoord veld.
    CSC-info
  1. Gebruik de volgende opdracht om informatie te krijgen over de CSC API-service van SSL.com. Als u zich in een sandbox-omgeving bevindt, gebruikt u https://cs-try.ssl.com/csc/v0/info gebruiken. 
    curl --location --request POST "https://cs.ssl.com/csc/v0/info" \ --header "Content-Type: application / json" \ --data-raw "{}"
  2. U ontvangt een JSON-object met details over de service:
    Krijg CSC-info

CSC-referentieslijst

Het CSC-referentieslijst request haalt een referentie op die u in latere API-verzoeken zult gebruiken.

Postman instructiescURL-instructies
  1. kies CSC-referentieslijst En klik op de knop autorisatie Tab.
    Autorisatie tabblad
  2. Kies Token aan toonder van het Type menu, plak je toegangstoken in het Token veld en klik vervolgens op Verzenden knop.
    Verzoek inloglijst verzenden
  3. Een JSON-object met een lijst met referentie-ID's die aan de gebruiker zijn gekoppeld, wordt weergegeven in het antwoord veld. Uw lijst bevat waarschijnlijk één waarde. Kopieer en plak uw identificatie-ID in een teksteditor voor gebruik in latere verzoeken.
    Referentie-ID's
  1. Voer de volgende opdracht in. (Vervang MY-ACCESS-TOKEN door uw huidige toegangstoken). Als u zich in een sandbox-omgeving bevindt, gebruikt u https://cs-try.ssl.com/csc/v0/credentials/list in plaats daarvan:
    curl --location --request POST "https://cs.ssl.com/csc/v0/credentials/list" \ --header "Content-Type: application / json" \ --header "Autorisatie: Bearer MY- ACCESS-TOKEN "\ --data-raw" {} "

    Als u een eseal-certificaat gebruikt (certificaat voor documentondertekening met alleen organisatie-informatie; inbegrepen bij uw gratis esigner.com-account), voeg dan "clientData" toe: "DS_ESEAL" (opmerking: voor eseals is geen OTP-authenticatie vereist). Andere opties voor “clientData” zijn “EVCS” voor EV Code Signing en “DS” (standaard) voor IV of IV+OV Document Signing:

    curl --location --request POST "https://cs.ssl.com/csc/v0/credentials/list" \ --header "Content-Type: application/json" \ --header "Autorisatie: Drager MIJN- TOEGANG TOKEN" \ --data-raw '{"clientData": "DS_ESEAL"}'
  2. U zou een JSON-object moeten ontvangen met een lijst met referentie-ID's die aan de gebruiker zijn gekoppeld. Uw lijst bevat waarschijnlijk één waarde. Kopieer en plak uw identificatie-ID in een teksteditor voor gebruik in latere verzoeken.
    Referentie-ID's

CSC-inloggegevens (optioneel)

Het CSC-inloggegevens request retourneert certificaten en andere informatie die aan een identificatie-ID is gekoppeld en is niet vereist voor ondertekening.

Postman instructiescURL-instructies
  1. Selecteer om dit verzoek te gebruiken CSC-inloggegevens uit de verzameling en klik op het autorisatie Tab.
    autorisatie tabblad
  2. Kies Token aan toonder van het Type menu en plak vervolgens uw toegangstoken in het Token veld.
    Plak token
  3. Selecteer het Lichaam tabblad en plak vervolgens uw referentie-ID als de waarde voor credentialID.
    Plak referentie-ID
  4. Klik op de Verzenden knop.
    Verzenden
  5. Een JSON-object met uw handtekeningcertificaatketen en andere informatie verschijnt in het antwoord veld.
    Inloggegevens
  1. Voer de volgende opdracht in. Als u zich in de sandbox-omgeving bevindt, gebruikt u https://cs-try.ssl.com/csc/v0/credentials/info  vervangen MY-ACCESS-TOKEN en MY-CREDENTIAL-ID met uw actuele informatie:
    curl --location --request POST "https://cs.ssl.com/csc/v0/credentials/info" \ --header "Content-Type: application/json" \ --header "Autorisatie: Drager MIJN- ACCESS-TOKEN" \ --data-raw '{ "credentialID": "MY-CREDENTIAL-ID", "certificates": "chain", "certInfo": true, "authInfo": true }'
  2. U zou een JSON-object moeten ontvangen met uw handtekeningcertificaatketen en andere informatie:
    CSC-inloggegevens

Inloggegevens autoriseren

Het Inloggegevens autoriseren request haalt autorisatie op voor het ondertekenen van een hash.

Postman instructiescURL-instructies
  1. Begin met selecteren Inloggegevens autoriseren uit de verzameling en klik op de autorisatie Tab.
    Autorisatie tabblad
  2. Kies Token aan toonder van het Type menu en plak vervolgens uw toegangstoken in het Token veld.
    plak token
  3. Selecteer het Lichaam tabblad. Plak uw referentie-ID als het credentialID waarde en een hash van het document dat u wilt ondertekenen als de hash waarde. Haal een OTP op van uw authenticatie-app en voer deze in als de waarde voor OTP, klik dan op de knop Verzenden knop. Opmerking: OTP is niet vereist voor het verzegelen van certificaten.
    Tabblad Hoofdtekst
  4. Een JSON-object met uw Signature Activation Data (SAD) verschijnt in het antwoord veld. Kopieer en plak deze waarde in een teksteditor voor gebruik in het verzoek om hash-ondertekening.
    ED
  1. Gebruik de volgende opdracht. Vervangen MY-ACCESS-TOKEN, MY-CREDENTIAL-ID en MY-HASH met uw actuele informatie. Ontvang een eenmalig wachtwoord van uw 2FA-applicatie en gebruik dit als de waarde voor MY-OTP. Opmerking: OTP is niet vereist voor het verzegelen van certificaten.
    curl --location --request POST "https://cs.ssl.com/csc/v0/credentials/authorize" \ --header "Content-Type: application/json" \ --header "Autorisatie: Drager MIJN- ACCESS-TOKEN" \ --data-raw '{ "credentialID": "MY-CREDENTIAL-ID", "numSignatures": 1, "hash": [ "MY-HASH" ], "OTP": "MY-OTP " }'
  2. U zou een JSON-object moeten ontvangen met uw Signature Activation Data (SAD). Kopieer en plak deze waarde in een teksteditor voor gebruik in het verzoek om hash-ondertekening.
    Inloggegevens autoriseren

Teken Hash

Nu bent u klaar om de document-hash te ondertekenen.

Postman instructiescURL-instructies
  1. kies Teken Hash uit de verzameling en selecteer vervolgens het autorisatie Tab.
    Autorisatie tabblad
  2. Kies Token aan toonder van het Type menu en plak vervolgens uw toegangstoken in het Token veld.
    Plak token
  3. Selecteer het Lichaam tabblad. Plak uw referentie-ID als het credentialID waarde, uw handtekeningactiveringsgegevens als de SAD waarde en een hash van het document dat u wilt ondertekenen als de hash waarde en klik vervolgens op het Verzenden knop.
    Tabblad Hoofdtekst
  4. Een JSON-object met uw handtekening verschijnt in het antwoord veld.
    Signature
  1. Voer de volgende opdracht in. Vervangen MY-ACCESS-TOKEN,  MY-CREDENTIAL-ID, MY-SAD en MY-HASH met uw actuele informatie:
    curl --location --request POST "https://cs.ssl.com/csc/v0/signatures/signHash" \ --header "Content-Type: application/json" \ --header "Autorisatie: Drager MIJN- ACCESS-TOKEN" \ --data-raw '{ "credentialID": "MY-CREDENTIAL-ID", "SAD": "MY-SAD", "hash": [ "MY-HASH" ], "signAlgo": "1.2.840.113549.1.1.11" }'
  2. U zou een JSON-object moeten ontvangen met uw handtekening.
    Teken hash
Ga naar boven

Teken een pdf

Naast het ondertekenen van document-hashes, kunt u ook een pdf-bestand uploaden en ondertekenen.

Bij het ondertekenen van een pdf werkt u met twee POST-verzoeken:

  • Upload PDF-document
  • Teken PDF-document

API-verzameling voor ondertekening van documenten

U kunt de inloggegevens die u hierboven heeft opgehaald opnieuw gebruiken met de CSC-referentieslijst verzoek. U zult waarschijnlijk ook een nieuw toegangstoken.

Upload PDF-document

Postman instructiescURL-instructies
  1. Selecteer het Upload PDF-document verzoek en klik op het autorisatie Tab.
    Autorisatie tabblad
  2. Kies Token aan toonder van het Type menu en plak vervolgens uw toegangstoken in het Token veld.
    Plak token
  3. Selecteer het Headers tabblad en plak uw referentie-ID in het Waarde kolom.
    Tabblad Headers
  4. Selecteer het Lichaam Tab en klik op de knop × naast hello.pdf om deze tijdelijke bestandsnaam te verwijderen.
    verwijder voorbeeld bestandsnaam
  5. Klik op de Selecteer bestand knop en navigeer vervolgens naar het bestand dat u wilt uploaden.
    Selecteer bestand
  6. Klik op de Verzenden knop.
    Verzenden
  7. Selecteer en kopieer het id waarde in het antwoord dat in het volgende verzoek moet worden gebruikt.
    ID
  1. Gebruik de volgende opdracht. Vervangen MY-CREDENTIAL-ID, MY-ACCESS-TOKEN en /PATH/TO/FILE.pdf met uw actuele informatie:
    curl --location --request POST "https://ds.ssl.com/v1/pdf/upload" \ --header "Credential-Id: MY-CREDENTIAL-ID" \ --header "Autorisatie: Bearer MY- ACCESS-TOKEN "\ --header" Content-Type: application / pdf "\ --data-binary" @ / PATH / TO / FILE.pdf "
  2. U ontvangt een JSON-object met een waarde voor id​ Kopieer deze waarde om te gebruiken in de volgende aanvraag.
    Upload PDF

Opmerking: Raadpleeg voor zichtbare handtekeningen de volgende HTTP-verzoekheaders (/v1/pdf/upload):

Koptekst aanvragen

Omschrijving

Referentie-ID

Unieke referentie-ID toegewezen aan de sleutel – Verplicht

Ondertekeningsreden:

Voeg ondertekeningsreden toe om toe te voegen in handtekeningweergave en ook in handtekeningwoordenboek - Optioneel, bijv. Ik keur dit document goed

Ondertekenlocatie

Voeg ondertekeningslocatie toe aan handtekeningwoordenboek – Optioneel, bijv. Houston, Texas

Contact informatie

Voeg contactgegevens toe aan het handtekeningwoordenboek - Optioneel, bijv. Telefoonnummer

Handtekening-veld-positie

Handtekeningveldpositie waar visuele handtekening wordt weergegeven. Het formaat is "x,y,breedte,hoogte" - Optioneel

Paginanummer

Paginanummer waar handtekening te trekken – Optioneel

Hand-handtekening

Base64-gecodeerde PNG-afbeelding van handhandtekening - Optioneel


Teken PDF-document

Nu kunt u de pdf ondertekenen.

OTP-autorisatie is niet vereist bij ondertekening met behulp van een certificaat voor verzegeling van documenten. Negeer alle OTP-parameters in de volgende handleiding als u een verzegelend documentondertekeningscertificaat gebruikt.
Postman instructiescURL-instructies
  1. Selecteer het Upload PDF-document verzoek en klik op het autorisatie Tab.
       autorisatie
  2. Kies Token aan toonder van het Type menu en plak vervolgens uw toegangstoken in het Token veld.
    Plak token
  3. Selecteer het tabblad Body, plak in het id waarde uit de vorige stap en een OTP van uw authenticatie-app, en klik vervolgens op het Verzenden knop.
    Verzend verzoek
  4. De PDF-gegevens verschijnen hieronder in het antwoord veld. Kiezen Opslaan in een bestand van het Sla reactie op menu en geef het bestand een naam.
    Bewaar PDF naar bestand
  5. Open het bestand in Acrobat om te bevestigen dat het bestand is ondertekend.
    Geldige handtekening
  1. Voer de volgende opdracht in. Vervangen MY-CREDENTIAL-ID, MY-FILE-ID en OUTPUT-FILENAME met uw actuele informatie. Haal een eenmalig wachtwoord (OTP) van uw 2FA-app en voer het in als MY-OTP. Opmerking: OTP is niet vereist voor het verzegelen van certificaten:
    curl --location --request POST 'https://ds.ssl.com/v1/pdf/sign' \ --header 'Content-Transfer-Encoding: application / json' \ --header 'Content-Type: applicatie / json '\ --header' Autorisatie: Bearer MY-ACCESS-TOKEN '\ --data-raw' {"id": "MY-FILE-ID", "otp": "MY-OTP"} '\ - -output OUTPUT-FILENAME
  2. cURL downloadt het ondertekende bestand en slaat het op onder de bestandsnaam die je hebt opgegeven:
    PDF ondertekenen
  3. Open de pdf in Acrobat of Acrobat Reader om te controleren of de handtekening geldig is.
    Geldige handtekening

Twitter
Facebook
LinkedIn
Reddit
E-mail

SSL.com-ondersteuningsteam

Auteur - Contentbeheerder
Alle berichten "