Integratiegids voor het testen van het ondertekenen van documenten op afstand met eSigner CSC API

Deze handleiding helpt u bij het ondertekenen van een document-hash en pdf-bestand met SSL.com's eSigner cloud-ondertekeningsservice en de Cloud Signature Consortium (CSC) API. Alle voorbeelden van API-verzoeken worden weergegeven met Postbode, en we raden aan om het Postman desktop-app op uw computer als u de voorbeelden wilt doornemen. cURL-opdrachtvoorbeelden van de API-verzoeken zijn ook opgenomen.

Maak een testorder

1. Eerst moet u een documentondertekeningsopdracht aanmaken in de Sandbox. Begin door in te loggen op uw Sandbox-account en naar het Overzicht Tab.
   
2. Klik 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.
   
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.
   
7. Voeg informatie over de aanvrager toe voor het testcertificaat en klik op het Volgende >> knop.
   
8. Voer de informatie van de ontvanger in en klik op het Volgende >> knop.
   
9. Klik op de overslaan om het uploaden van validatiedocumenten voor het testcertificaat over te slaan.
   
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.
    

Schrijf u in voor eSigner en stel twee-factorenauthenticatie in

1. Zodra uw testbestelling is gevalideerd door het ondersteuningspersoneel van SSL.com, kunt u deze in eSigner registreren. Navigeer naar het Bestellingen tab in uw SSL.com sandbox-account en zoek uw testbestelling.
   
2. Klik op de bestelling gegevens link.
   
3. Maak 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.
   
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.
   
5. Scan de code naar een 2-factor authenticatie-app op uw mobiele apparaat, zoals Google Authenticator of Authy. De app geeft u eenmalige wachtwoorden (OTP's) die u kunt gebruiken bij het ondertekenen. Elke OTP is 30 seconden geldig.
   

Install Postbode en CSC API-verzameling importeren

1. Download en pak het uit CSC API Postman-collectie (Zie https://www.postman.com/sslcom/workspace/public/collection/3420801-f2df0995-1293-45da-8719-73467c9f0ca7?ctx=documentation voor de nieuwste api-eindpunten of collectiedownloads).
   
2. Download en installeer de Postman REST-client.
   
3. Start Postman en maak vervolgens een nieuw Postman-account aan of log in op een bestaand account.
   
4. Klik op de import knop.
   
5. Klik op de Upload bestanden knop, navigeer naar het uitgepakte API-verzamelingsbestand (CSC-API.postman_collection.json), en open het.
   
6. Klik op de import knop.
   
7. Klik op de Collecties tab in Postman en vouw de CSC API-collectie uit om de vijf POST-verzoeken te bekijken waarmee je gaat werken:
   • CSC-info
   • CSC-referentieslijst
   • CSC-inloggegevens
   • Inloggegevens autoriseren
   • Teken Hash

   

Toegangstoken ophalen

1. De volgende stap is om een ​​toegangstoken op te halen bij SSL.com. Voordat u uw toegangstoken aanvraagt, heeft u een klant-ID (ook bekend als een Applicatie ID. Raadpleeg deze how-to voor instructies over het genereren van deze referentie).
2. Selecteer het autorisatie tab, selecteer OAuth 2.0 aan de hand van de Type menu en klik op Krijg een nieuw toegangstoken knop.
   
3. Voer de volgende informatie in het formulier in:
   • Token Naam: SandBox CSC (of een andere gemakkelijk te onthouden naam die u verkiest)
   • Soort subsidie: Authorisatie Code
   • Terugbel-URL: [Leeg laten]
   • Autoriseren via browser: gecontroleerd
   • Verificatie-URL: https://oauth-sandbox.ssl.com/oauth2/authorize
   • Toegangstoken-URL: https://oauth-sandbox.ssl.com/oauth2/token
   • Klant identificatie: [Uw klant-ID]
   • Cliëntgeheim: [Uw klantgeheim]
   • Domein: service
   • Staat: [Leeg laten]
   • Clientverificatie: Verzenden als Basic Auth-header

   Als u klaar bent, klikt u op het Verzoektoken knop.
   

4. Een inlogformulier zal in uw webbrowser verschijnen. Voer uw SSL.com gebruikersnaam en wachtwoord in en klik op het Leden knop.
   
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 Postbode verzoeken, maar we hebben geconstateerd dat het het meest betrouwbaar is om het token rechtstreeks in elk verzoek te kopiëren en te plakken.
   

Teken een hash

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

CSC-info opvragen (optioneel)

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 aan de hand van de CSC-API verzameling en klik vervolgens op het Verzenden knop.
   
2. Informatie over de cloud-handtekeningservice wordt weergegeven in een JSON-object in Postman's antwoord veld.
   

cURL-opdracht

curl --location --request POST "https://cs-try.ssl.com/csc/v0/info" \ --header "Content-Type: application / json" \ --data-raw "{}"

CSC-referentieslijst

1. Dé CSC-referentieslijst request haalt een referentie op die je in latere API-verzoeken zult gebruiken. Selecteer CSC-referentieslijst En klik op de knop autorisatie Tab.
   
2. Kies Token aan toonder aan de hand van de Type menu, plak je toegangstoken in het Token veld en klik vervolgens op Verzenden knop.
   
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.
   

cURL-opdracht

vervangen MY-ACCESS-TOKEN met uw daadwerkelijke toegangstoken:

curl --location --request POST "https://cs-try.ssl.com/csc/v0/credentials/list" \ --header "Content-Type: application / json" \ --header "Autorisatie: Bearer MIJN-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-try.ssl.com/csc/v0/credentials/list" \ --header "Content-Type: application/json" \ --header "Autorisatie: Bearer MIJN-ACCESS-TOKEN" \ --data-raw "{\"clientData\": \"DS_ESEAL\"}"

CSC-inloggegevens (optioneel)

1. Dé CSC-inloggegevens request retourneert certificaten en andere informatie die aan een identificatie-ID is gekoppeld en is niet vereist voor ondertekening. Selecteer om dit verzoek te gebruiken CSC-inloggegevens uit de verzameling en klik op het autorisatie Tab.
   
2. Kies Token aan toonder aan de hand van de Type menu en plak vervolgens uw toegangstoken in het Token veld.
   
3. Selecteer het Lichaam tabblad en plak vervolgens uw referentie-ID als de waarde voor credentialID.
   
4. Klik op de Verzenden knop.
   
5. Een JSON-object met uw handtekeningcertificaatketen en andere informatie verschijnt in het antwoord veld.
   

cURL-opdracht

vervangen MY-ACCESS-TOKEN en MY-CREDENTIAL-ID met uw actuele informatie:

curl --location --request POST "https://cs-try.ssl.com/csc/v0/credentials/info" \ --header "Content-Type: application / json" \ --header "Autorisatie: Bearer MY-ACCESS-TOKEN "\ --data-raw" {\ "credentialID \": \ "MY-CREDENTIAL-ID \", \ "certificaten \": \ "chain \", \ "certInfo \": waar, \ "authInfo \": true} "

Inloggegevens autoriseren

1. Dé Inloggegevens autoriseren request haalt de autorisatie op voor het ondertekenen van een hash. Begin met het selecteren Inloggegevens autoriseren uit de verzameling en klik op de autorisatie Tab.
   
2. Kies Token aan toonder aan de hand van de Type menu en plak vervolgens uw toegangstoken in het Token veld.
   
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.
   
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.
   

cURL-opdracht

vervangen MY-ACCESS-TOKEN,  MY-CREDENTIAL-ID, MY-HASH en MY-OTP met uw actuele informatie:

curl --location --request POST "https://cs-try.ssl.com/csc/v0/credentials/authorize" \ --header "Content-Type: application / json" \ --header "Autorisatie: Bearer MY-ACCESS-TOKEN "\ --data-raw" {\ "credentialID \": \ "MY-CREDENTIAL-ID \", \ "numSignatures \": 1, \ "hash \": [\ "MY-HASH \ "], \" OTP \ ": \" MY-OTP \ "}"

Teken Hash

1. Nu zijn we klaar om de document-hash te ondertekenen. Selecteer Teken Hash uit de verzameling en selecteer vervolgens het autorisatie Tab.
   
2. Kies Token aan toonder aan de hand van de Type menu en plak vervolgens uw toegangstoken in het Token veld.
   
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.
   
4. Een JSON-object met uw handtekening verschijnt in het antwoord veld.
   

cURL-opdracht

vervangen MY-ACCESS-TOKEN,  MY-CREDENTIAL-ID, MY-SAD en MY-HASH met uw actuele informatie:

curl --location --request POST "https://cs-try.ssl.com/csc/v0/signatures/signHash" \ --header "Content-Type: application / json" \ --header "Autorisatie: Bearer MY-ACCESS-TOKEN "\ --data-raw" {\ "credentialID \": \ "MY-CREDENTIAL-ID \", \ "SAD \": \ "MY-SAD \", \ "hash \": [\ "MY-HASH \"], \ "signAlgo \": \ "1.2.840.113549.1.1.11 \"} "

Teken een pdf

Naast het ondertekenen van document-hashes, kunt u ook een pdf-bestand uploaden en ondertekenen. Begin met het downloaden en importeren van het Document Signing API Postman-collectie (Zie https://www.postman.com/sslcom/workspace/public/collection/3454644-277d8427-f749-4a94-93bf-c3478b79b999?ctx=documentation voor de nieuwste api-eindpunten en collectiedownloads), volgens dezelfde installatiestappen u hierboven hebt gevolgd voor de CSC API-verzameling.

• Upload PDF-document
• Teken PDF-document

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

1. Selecteer het Upload PDF-document verzoek en klik op het autorisatie Tab.
   
2. Kies Token aan toonder aan de hand van de Type menu en plak vervolgens uw toegangstoken in het Token veld.
   
3. Selecteer het Headers tabblad en plak uw referentie-ID in het Waarde kolom.
   
4. Selecteer het Lichaam Tab en klik op de knop × naast hello.pdf om deze tijdelijke bestandsnaam te verwijderen.
   
5. Klik op de Selecteer bestand knop en navigeer vervolgens naar het bestand dat u wilt uploaden.
   
6. Klik op de Verzenden knop.
   
7. Selecteer en kopieer het id waarde in het antwoord dat in het volgende verzoek moet worden gebruikt.
   

cURL-opdracht

vervangen MY-CREDENTIAL-ID, MY-ACCESS-TOKEN en /PATH/TO/FILE.pdf met uw actuele informatie:

curl --location --request POST "https://ds-try.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 "

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

Teken PDF-document

1. Nu kunt u de pdf ondertekenen. Selecteer de Upload PDF-document verzoek en klik op het autorisatie Tab.
     
2. Kies Token aan toonder aan de hand van de Type menu en plak vervolgens uw toegangstoken in het Token veld.
   
3. Selecteer het tabblad Hoofdgedeelte en plak in het id waarde uit de vorige stap.
   
4. Voer een OTP in vanuit uw authenticatie-app en klik op het Verzenden knop.
   
5. De PDF-gegevens verschijnen hieronder in het antwoord veld. Kiezen Opslaan in een bestand aan de hand van de Sla reactie op menu en geef het bestand een naam.
   
6. Open het bestand in Acrobat om te bevestigen dat het bestand is ondertekend. (Merk op dat in de onderstaande schermafbeelding de RSA Development-root van SSL.com handmatig wordt vertrouwd in Acrobat.)
   

cURL-opdracht

vervangen MY-CREDENTIAL-ID, MY-FILE-ID en MY-OTP met uw actuele informatie:

curl --location --request POST "https://ds-try.ssl.com/v1/pdf/sign" \ --header "Content-Transfer-Encoding: application / json" \ --header "Content-Type : application / json "\ --header" Autorisatie: Bearer MY-ACCESS-TOKEN "\ --data-raw" {\ "id \": \ "MY-FILE-ID \", \ "otp \": \ "MY-OTP \"} "

 Live gaan met productie

Om live te gaan, moet u "-try" uit het subdomein verwijderen. Om bijvoorbeeld live te gaan met ds-try.ssl.com, verwijdert u “-try” zodat het subdomein ds.ssl.com wordt.