Integratsioonijuhend dokumentide kaugallkirjastamise testimiseks eSigner CSC API-ga

See juhend juhatab teid dokumendi räsi ja PDF-faili allkirjastamisele SSL.com-dega e-allkirjastaja pilveallkirjastamisteenus ja pilvealkirja konsortsiumi (CSC) API. Kõiki API taotluste näiteid kuvatakse koos Kirjakandjaja soovitame installida Postmani töölauarakendus arvutis, kui soovite näiteid läbi töötada. Lisatud on ka API-päringute cURL-i näited.

Looge testtellimus

1. Kõigepealt peate looma liivakasti dokumendi allkirjastamise järjekorra. Alustage oma liivakasti kontole sisselogimisega ja minge saidile armatuurlaud Tab.
   
2. Click arendaja tööriistad.
   
3. valima eSigneri dokumendi allkirjastamine, Seejärel klõpsake nuppu Koosta testikorraldus nuppu.
   
4. Ilmub dialoogiboks. Klõpsake nuppu OK nuppu.
   
5. Leidke testtellimus ja klõpsake nuppu detailid link.
   
6. Click redigeerige registreerijat alustada oma tellimuse jaoks taotleja ja saaja teabe sisestamist. Pange tähele, et kuna seda teavet ei kasutata kehtiva dokumendi allkirjastamise sertifikaadi väljaandmiseks, võite soovi korral sisestada fiktiivse teabe.
   
7. Lisage testisertifikaadi taotleja teave ja seejärel klõpsake nuppu Järgmine >> nuppu.
   
8. Sisestage saaja teave ja seejärel klõpsake nuppu Järgmine >> nuppu.
   
9. kliki Jäta vahele nupp testisertifikaadi valideerimisdokumentide üleslaadimise vahele jätmiseks.
   
10. Teie testtellimuse olek peaks olema nüüd ootel kinnitamist. Võtke ühendust SSL.com tugimeeskonnaga aadressil Support@SSL.com testisertifikaadi kinnitamiseks.
    

Registreeruge eSigneris ja seadistage kahefaktoriline autentimine

1. Kui SSL.com tugiteenused on teie tellimuse kinnitanud, saate selle registreerida eSigneris. Navigeerige lehele Tellimused vahekaardil oma SSL.com liivakasti kontol ja leidke oma testjärjestus.
   
2. Klõpsake tellimuse oma detailid link.
   
3. Looge ja kinnitage 4-kohaline PIN-kood, seejärel klõpsake nuppu loo PIN-kood nuppu.
   
   Kui peate e-allkirja PIN-koodi lähtestama, lugege palun see kuidas?.
   
4. Ilmub QR-kood.
   
   Järgmine kord, kui laadite lehe uuesti, pole QR-kood nähtav. Kui peate oma eSigneri QR-koodi vaatama või lähtestama, lugege palun see kuidas?.
   
5. Skannige kood oma mobiilseadmes kahefaktoriliseks autentimisrakenduseks, näiteks Google Authenticator või Authy. Rakendus annab teile ühekordsed paroolid (OTP-d) kasutamiseks allkirjastamisel. Iga OTP kehtib 2 sekundit.
   

paigaldama Kirjakandja ja Impordi CSC API kollektsioon

1. Laadige alla ja pakkige CSC API Postmani kogu (Vt https://www.postman.com/sslcom/workspace/public/collection/3420801-f2df0995-1293-45da-8719-73467c9f0ca7?ctx=documentation uusimate API lõpp-punktide või kogude allalaadimiste jaoks).
   
2. Laadige alla ja installige Postimees REST klient.
   
3. Käivitage Postman, seejärel looge uus Postmani konto või logige sisse olemasolevasse.
   
4. kliki Import nuppu.
   
5. kliki Faile üles laadima nuppu, navigeerige pakkimata API kogufaili (CSC-API.postman_collection.json) ja avage see.
   
6. kliki Import nuppu.
   
7. kliki Kollektsioonid Postmani vahekaardil ja laiendage CSC API kogu, et näha viit POST-taotlust, millega töötate:
   • CSC teave
   • CSC mandaatide loend
   • CSC volituste teave
   • Volitused volitavad
   • Logi Hash

   

Too juurdepääsuluba

1. Järgmine samm on juurdepääsuloa hankimine saidilt SSL.com. Enne juurdepääsuloa taotlemist vajate a kliendi ID (tuntud ka kui Rakenduse ID. Palun viita see kuidas? juhiste saamiseks selle mandaadi loomiseks).
2. Valige luba vahekaardil valige OAuth 2.0 alates KASUTUSALA ja klõpsake nuppu Hankige uus juurdepääsuluba nuppu.
   
3. Sisestage vormile järgmine teave:
   • Märgi nimi: SandBox CSC (või mõni muu hõlpsasti meeldejääv nimi, mida eelistate)
   • Toetuse tüüp: Autoriseerimiskood
   • Tagasihelistamise URL: [Jäta tühjaks]
   • Volitage brauseri abil: kontrollitud
   • Autentimise URL: https://oauth-sandbox.ssl.com/oauth2/authorize
   • Juurdepääsu märgi URL: https://oauth-sandbox.ssl.com/oauth2/token
   • Kliendi ID: [Teie kliendi ID]
   • Kliendi saladus: [Teie kliendisaladus]
   • Reguleerimisala: teenus
   • Riik: [Jäta tühjaks]
   • Kliendi autentimine: Saada päise põhiautentina

   Kui olete lõpetanud, klõpsake nuppu Taotle märki nuppu.
   

4. Teie veebibrauseris kuvatakse sisselogimisvorm. Sisestage oma SSL.com kasutajanimi ja parool, seejärel klõpsake nuppu sisselogimine nuppu.
   
5. Teie uus juurdepääsuluba peaks ilmuma Postmanis. Valige juurdepääsuloa tekst ja kopeerige see lõikelauale, seejärel sulgege Juurdepääsulubade haldamine Dialoogikast. Kleepige juurdepääsuluba tekstiredaktorisse, kus saate sellele hõlpsasti juurde pääseda. Iga juurdepääsuluba aegub ühe tunni pärast.
   
   Samuti saate oma märgi uuesti kasutamiseks salvestada Kirjakandja taotlusi, kuid oleme leidnud, et kõige usaldusväärsem on märgi kopeerimine ja kleepimine otse igasse päringusse.
   

Allkirjastage Hash

Nüüd, kui teil on juurdepääsuluba, saate alustada API taotluste esitamist ja allkirjade loomist. See jaotis juhatab teid läbi viie saadaoleva taotluse Postimees CSC kollektsioon, mille tulemusena luuakse dokumendiräsist digitaalallkiri.

Hankige CSC-teave (valikuline)

1. Võite kasutada CSC teave taotlus saada teavet SSL.com pilvealkirjateenuse kohta. Pange tähele, et erinevalt teistest kogu kollektsioonist ei nõua see taotlus teie juurdepääsuluba. Taotluse saatmiseks valige CSC teave alates CSC API seejärel klõpsake nuppu Saada nuppu.
   
2. Teave pilvealkirjateenuse kohta kuvatakse Postmansi JSON-i objektis Vastus valdkonnas.
   

käsk cURL

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

CSC mandaatide loend

1. . CSC mandaatide loend taotlus hankib mandaadi, mida kasutate hilisemates API-taotlustes. Valige CSC mandaatide loend ja klõpsake luba Tab.
   
2. Vali Kandja tunnus alates KASUTUSALA menüüs kleepige juurdepääsuluba Sümboolne klõpsake nuppu Saada nuppu.
   
3. JSON-objekt koos kasutajaga seotud mandaadi ID-de loendiga kuvatakse Vastus valdkonnas. Teie loend sisaldab tõenäoliselt ühte väärtust. Kopeerige ja kleepige oma mandaadi ID tekstiredaktorisse, et seda hiljem kasutada.
   

käsk cURL

asendama MY-ACCESS-TOKEN teie tegeliku juurdepääsulubaga:

curl --location --request POST "https://cs-try.ssl.com/csc/v0/credentials/list" \ --header "Content-Type: application / json" \ --header "Autoriseerimine: Kandja MINU-JUURDEPÄÄS-TOKEN "\ --andmete-toores" {} "

Kui kasutate eseal-sertifikaati (dokumendi allkirjastamise sertifikaat ainult organisatsiooni teabega; kaasas teie tasuta esigner.com-i kontole), lisage "clientData": "DS_ESEAL" (märkus: eseals ei nõua OTP-autentimist). Muud valikud „clientData” jaoks on „EVCS” EV-koodi allkirjastamiseks ja „DS” (vaikimisi) IV või IV+OV dokumentide allkirjastamiseks:

curl --location --request POST "https://cs-try.ssl.com/csc/v0/credentials/list" \ --header "Sisu tüüp: application/json" \ --header "Autoriseerimine: kandja MY-ACCESS-TOKEN" \ --data-raw "{\"clientData\": \"DS_ESEAL\"}"

CSC mandaatide teave (valikuline)

1. . CSC volituste teave taotlus tagastab sertifikaadid ja muu mandaadi ID-ga seotud teabe ning pole allkirjastamiseks vajalik. Selle päringu kasutamiseks valige CSC volituste teave kollektsioonist ja klõpsake nuppu luba Tab.
   
2. Vali Kandja tunnus alates KASUTUSALA menüü, seejärel kleepige juurdepääsuluba Sümboolne valdkonnas.
   
3. Valige Keha vahekaardil ja kleepige seejärel oma mandaadi ID väärtuseks credentialID.
   
4. kliki Saada nuppu.
   
5. JSON-i objekt koos teie allkirjastamise sertifikaatide ahela ja muu teabega kuvatakse Vastus valdkonnas.
   

käsk cURL

asendama MY-ACCESS-TOKEN ja MY-CREDENTIAL-ID oma tegeliku teabega:

curl --location --request POST "https://cs-try.ssl.com/csc/v0/credentials/info" \ --header "Content-Type: application / json" \ --header "Autoriseerimine: Kandja MINU-JUURDEPÄÄS-TOKEN "\ --data-toores" {\ "credentialID \": \ "MINU-KREDENTAAL-ID \", \ "sertifikaadid \": \ "kett \", \ "certInfo \": true, \ "authInfo \": true} "

Volitused volitavad

1. . Volitused volitavad taotlus hankib räsi allkirjastamiseks volituse. Alustage valimisega Volitused volitavad kollektsioonist ja klõpsates nuppu luba Tab.
   
2. Vali Kandja tunnus alates KASUTUSALA menüü, seejärel kleepige juurdepääsuluba Sümboolne valdkonnas.
   
3. Valige Keha vaheleht. Kleepige oma mandaadi ID credentialID väärtus ja räsi dokumendist, millele soovite alla kirjutada hash väärtus. Leidke ja sisestage oma autentimisrakendusest OTP ja sisestage see väärtuseks OTP, Seejärel klõpsake nuppu Saada nuppu.
   
4. JSON-i objekt, millel on teie allkirja aktiveerimise andmed (SAD), ilmub Vastus valdkonnas. Kopeerige ja kleepige see väärtus tekstiredaktorisse, et seda räsi allkirjastamistaotluses kasutada.
   

käsk cURL

asendama MY-ACCESS-TOKEN,  MY-CREDENTIAL-ID, MY-HASHja MY-OTP oma tegeliku teabega:

curl --location --request POST "https://cs-try.ssl.com/csc/v0/credentials/authorize" \ --header "Content-Type: application / json" \ --header "Autoriseerimine: Kandja MINU-JUURDEPÄÄS-TOKEN "\ --data-toores" {\ "mandaadi ID": \ "MINU-KREDENTAAL-ID \", \ "numSignatures \": 1, \ "räsi \": [\ "MINU-HASH \ "], \" OTP \ ": \" MINU-OTP \ "}"

Logi Hash

1. Nüüd oleme valmis dokumendi räsile alla kirjutama. Valige Logi Hash kogust ja valige seejärel luba Tab.
   
2. Vali Kandja tunnus alates KASUTUSALA menüü, seejärel kleepige juurdepääsuluba Sümboolne valdkonnas.
   
3. Valige Keha vaheleht. Kleepige oma mandaadi ID credentialID väärtus, teie allkirja aktiveerimise andmed kui SAD väärtus ja räsi dokumendist, millele soovite alla kirjutada hash väärtus, siis klõpsake nuppu Saada nuppu.
   
4. Teie allkirjaga JSON-objekt ilmub Vastus valdkonnas.
   

käsk cURL

asendama MY-ACCESS-TOKEN,  MY-CREDENTIAL-ID, MY-SADja MY-HASH oma tegeliku teabega:

curl --location --request POST "https://cs-try.ssl.com/csc/v0/signatures/signHash" \ --header "Content-Type: application / json" \ --header "Autoriseerimine: Kandja MINU-JUURDEPÄÄS-TOKEN "\ --data-toores" {\ "credentialID \": \ "MINU-KREDENTAAL-ID \", \ "SAD \": \ "MINU-KAD", \ "räsi \": [\ "MINU-HASH \"], \ "signAlgo \": \ "1.2.840.113549.1.1.11 \"} "

Allkirjastage PDF

Lisaks dokumendi rässide allkirjastamisele saate üles laadida ja alla kirjutada ka PDF-faili. Alustage faili allalaadimine ja importimine Dokumendi allkirjastamise API Postmani kogu (Vt https://www.postman.com/sslcom/workspace/public/collection/3454644-277d8427-f749-4a94-93bf-c3478b79b999?ctx=documentation uusimate API lõpp-punktide ja kogude allalaadimiste jaoks), järgides sama paigaldamise etapid järgisite CSC API kollektsiooni eespool.

• Laadige üles PDF-dokument
• Allkirjastage PDF-dokument

Võite uuesti kasutada ülaltoodud mandaate CSC mandaatide loend taotlus. Tõenäoliselt peate hankima ka uue juurdepääsukutse.

Laadige üles PDF-dokument

1. Valige Laadige üles PDF-dokument ja klõpsake nuppu luba Tab.
   
2. Vali Kandja tunnus alates KASUTUSALA menüü, seejärel kleepige juurdepääsuluba Sümboolne valdkonnas.
   
3. Valige Päised vahekaardil ja kleepige oma mandaadi ID Väärtus kolonni.
   
4. Valige Keha sakk ja klõpsake × kõrval hello.pdf selle kohahoidja failinime eemaldamiseks.
   
5. kliki Valige Fail nupp ja seejärel navigeerige faili juurde, mille soovite üles laadida.
   
6. kliki Saada nuppu.
   
7. Valige ja kopeerige id väärtus vastuses, mida kasutada järgmises taotluses.
   

käsk cURL

asendama MY-CREDENTIAL-ID, MY-ACCESS-TOKENja /PATH/TO/FILE.pdf oma tegeliku teabega:

curl --location --request POST "https://ds-try.ssl.com/v1/pdf/upload" \ --header "Credential-Id: MY-CREDENTIAL-ID" \ --header "Autoriseerimine: Kandja MINU-JUURDEPÄÄS-TOKEN "\ --head" Sisutüüp: application / pdf "\ --data-binary" @ / PATH / TO / FILE.pdf "

Märkus. Nähtavate allkirjade jaoks vaadake järgmisi HTTP päringu päiseid (/v1/pdf/upload):

Allkirjastage PDF-dokument

1. Nüüd saate PDF-failile alla kirjutada. Valige Laadige üles PDF-dokument ja klõpsake nuppu luba Tab.
     
2. Vali Kandja tunnus alates KASUTUSALA menüü, seejärel kleepige juurdepääsuluba Sümboolne valdkonnas.
   
3. Valige vahekaart Keha ja kleepige id väärtus eelmisest etapist.
   
4. Sisestage oma autentimisrakenduses OTP ja klõpsake nuppu Saada nuppu.
   
5. PDF-andmed ilmuvad allpool Vastus valdkonnas. Valige Salvesta faili alates Salvesta vastus menüüle, siis andke failile nimi.
   
6. Avage fail Acrobatis ja veenduge, et fail on allkirjastatud. (Pange tähele, et alloleval ekraanipildil on SSL.com RSA arendusjuurt Acrobatis käsitsi usaldatud.)
   

käsk cURL

asendama MY-CREDENTIAL-ID, MY-FILE-IDja MY-OTP oma tegeliku teabega:

curl --location --request POST "https://ds-try.ssl.com/v1/pdf/sign" \ --header "Content-Transfer-Encoding: application / json" \ --header "Content-Type : application / json "\ --header" Autoriseerimine: Kandja MINU-JUURDEPÄÄS-TOKEN "\ --andmete-toores" {\ "id \": \ "MINU-FILE-ID", \ "otp \": \ "MY-OTP \"}

 Tootmisega otseülekanne

Reaalajas esitamiseks peate alamdomeenist eemaldama „-try”. Näiteks veebisaidile ds-try.ssl.com otseülekandeks eemaldage „-try”, et alamdomeenist saaks ds.ssl.com.