See juhend näitab teile, kuidas registreerida dokumendi allkirjastamise sertifikaadi tellimine SSLD-dega e-allkirjastaja teenust ja kasutage Cloud Signature Consortiumi (CSC) API-d dokumendi räsi ja PDF-faili digitaalseks allkirjastamiseks. Seda juhendit saate kasutada mõlemaga Curl or Kirjakandja. Soovitame Postmani kasutajatel installida lauaarvuti rakendus näidete läbitöötamiseks. Selle juhendi näited kehtivad nii saidi SSL.com tootmis- kui ka testimiskeskkondade eSigner ja eSealing jaoks. Tootmis- ja katserežiimide käskude erinevusi selgitatakse järgmistes jaotistes.
Nende juhiste järgimiseks vajate järgmist.
- Valideeritud dokumendi allkirjastamise sertifikaadi tellimus. Palun lugege see kuidas? tellimise ja kinnitamise täielike juhiste saamiseks.
- A kliendi ID (tuntud ka kui Rakenduse ID. Palun viita see kuidas? juhiste saamiseks selle mandaadi loomiseks).
Tellige oma SSL.com-i dokumendi allkirjastamise sertifikaat
Kuidas tellida sertifikaati tootmiskeskkonnas
Tootmisdokumendi allkirjastamise sertifikaadi tellimise juhised leiate sellest juhendi artiklist: Koodi ja dokumentide allkirjastamise sertifikaatide tellimisprotsess
Kuidas tellida testisertifikaati saidi SSL.com liivakastis
SSL.com pakub spetsiaalset liivakastikeskkonda, mis peegeldab meie reaalajas SSL.com-i portaali ja SWS API-t, et luua riskivaba eksperimenteerimisruum. See "labori" seade võimaldab kasutajatel SSL.com-i teenuseid uurida ja testida, ilma et peaksite muretsema häirete või tegelike kulude pärast.
Artikkel, SSL.com liivakasti kasutamine testimiseks ja integreerimiseks, aitab teil liikuda liivakasti konto loomise, testtellimuse algatamise ja liivakasti integreerimise protsessis SWS API-ga.
Kui olete testsertifikaadi loonud, võtke selle kinnitamiseks ühendust saidi SSL.com tugitiimiga. Seda saate teha, klõpsates veebivestluse nuppu all paremas nurgas SSL.com veebisaidil või meili saatmisega support@ssl.com.
Registreeruge eSigneris ja seadistage kahefaktoriline autentimine
Enne kui saate CSC API-d kasutama hakata, peate registreeruma SSL.com-i pilvallkirjastamise teenuses eSigner. Kinnitatud tellimusi saab eSignerisse registreerida, järgides alltoodud juhiseid:
- . Navigeerige lehele Tellimused oma SSL.com konto vahekaardil ja leidke oma tellimus.
- Klõpsake tellimuse oma detailid link.
- Looge a 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?.
- 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?.
- Skannige kood oma mobiilseadme kahefaktoriliseks autentimisrakenduseks, näiteks Google Authenticator or Authy. Rakendus annab teile ühekordsed paroolid (OTP-d) kasutamiseks allkirjastamisel. Iga OTP kehtib 30 sekundit.
Valikuline: teisendage oma OV dokumendi allkirjastamise sertifikaat pitseerimissertifikaadiks
Märge: See jaotis on mõeldud ainult kasutajatele, kes soovivad tihendada. Dokumendi allkirjastamise automatiseerimiseks ja mitte ühekordsete paroolide (OTP) küsimise vältimiseks teisendavad kasutajad oma organisatsiooni valideerimise (OV) dokumendi allkirjastamise sertifikaadi ise oma SSL.com-i kontodel pitseerimissertifikaadiks. Pange tähele, et individuaalse kinnitamise (IV) dokumendi allkirjastamise sertifikaati ei saa muuta pitseerimiseks. Tihendi muutmise juhised on üksikasjalikud allpool:
- Click Tellimused oma SSL.com-i konto ülemises menüüs.
- Leidke oma sertifikaat ja klõpsake nuppu allalaadimine / üksikasjad link.
- kliki EEMALDA 2FA nuppu.
Installige Postman ja importige API kogud
Selles jaotises olevad juhised on mõeldud ainult Postmani kasutajatele. Kui kasutate cURL-i CSC API-ga, saate liikuda järgmisele jaotisele.
- Laadige alla ja pakkige CSC API Postmani kogu ja Dokumendi allkirjastamise API Postmani kogu (Vt https://www.postman.com/sslcom veebipõhise SSL.com API kogude jaoks).
- Laadige alla ja installige Postimees REST klient.
- Käivitage Postman, seejärel looge uus Postmani konto või logige sisse olemasolevasse.
- kliki Import nuppu.
- kliki Faile üles laadima nuppu, navigeerige lahtipakitud API kogufailide juurde (
csc-api-prod.postman_collection.jsonjadocument-signing-api-prod.postman_collection.json) ja avage need.
- kliki Import nuppu.
- API-taotlused, millega töötate, on nüüd rakenduses saadaval Kollektsioonid vahekaart Postimehe akna vasakul küljel.
Too juurdepääsuluba
Järgmine samm on juurdepääsuloa hankimine saidilt SSL.com. Teil on vaja oma kliendi ID saadaval, samuti teie SSL.com konto kasutajanimi ja parool. Juurdepääsumärgid kehtivad üks tund pärast nende väljastamist.
Postmani või CURL-i juhiste valimiseks kasutage allpool klõpsatavaid vahelehti:
- Valige CSC API kogust API taotlus.
- Valige luba Sakk ja valige OAuth 2.0 alates KASUTUSALA menüü.
- Sisestage vormile järgmine teave:
- Päise eesliide:
Bearer - Märgi nimi:
SSLCOM CSC(või mõni muu meeldejääv nimi, mida eelistate) - Toetuse tüüp:
Authorization Code - Tagasihelistamise URL:
https://upload.esigner.com - Volitage brauseri abil: kontrollimata
- Autentimise URL:
https://login.ssl.com/oauth2/authorizeTootmiskeskkonna jaoks;https://oauth-sandbox.ssl.com/oauth2/authorizeliivakasti keskkonna jaoks. - Juurdepääsu märgi URL:
https://login.ssl.com/oauth2/tokenTootmiskeskkonna jaoks;https://oauth-sandbox.ssl.com/oauth2/tokenliivakasti keskkonna jaoks. - Kliendi ID: [Teie kliendi ID]
- Kliendi saladus: [Teie kliendisaladus]
- Reguleerimisala:
service - Riik: [Jäta tühjaks]
- Kliendi autentimine:
Send as Basic Auth header
Kui olete lõpetanud, klõpsake nuppu Hankige uus juurdepääsuluba nuppu.
- Päise eesliide:
- Ilmub sisselogimisvorm. Sisestage oma SSL.com kasutajanimi ja parool, seejärel klõpsake nuppu sisselogimine nuppu.
- 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.
Postimehe taotlustes saate ka oma loa taaskasutamiseks salvestada, kuid oleme leidnud, et kõige usaldusväärsem on märgendi kopeerimine ja kleepimine otse igasse päringusse.
- Juurdepääsuloa taotlemiseks kasutage järgmist käsku. Asendage jaotises ALL-CAPS näidatud väärtused oma tegelike väärtustega:
curl --location --request POST "https://login.ssl.com/oauth2/token" \ --header "Content-Type: application/json" \ --data-raw '{ "kliendi_id" : "TEIE -KLIENDI-ID", "kliendi_saladus" : "SINU-KLIENDI-SALADUS", "grant_type" : "parool", "kasutajanimi" : "TEIE-KASUTAJANIMI", "parool" : "TEIE-PAROOL" }' - Te peaksite saama JSON-i objekti, mis sisaldab juurdepääsuluba ja värskendusmärki. Kopeerige oma API taotlustesse kleepimiseks juurdepääsuloa väärtus. Nende näidete jaoks pole vaja värskendamisluba.
Allkirjastage Hash
Nüüd, kui teil on juurdepääsuluba, võite alustada API-taotluste esitamist ja allkirjade loomist. See jaotis juhatab teid läbi viis saadaolevat päringut Postman CSC kollektsioonis, mille tulemuseks on digitaalse allkirja loomine dokumendi räsist.
- PDF-teeki on vaja PDF-i manipuleerimiseks räsi sisestamiseks ja hiljem PKCS#7 manustamiseks PDF-dokumenti. (nt Javas ApachePDFBox).
- Krüptoteek PKCS#7 loomiseks eSigner API-lt saadud toorallkirjadest (nt Javas BouncyCastle).
Hankige CSC-teave (valikuline)
- 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.
- Teave pilvealkirjateenuse kohta kuvatakse Postmansi JSON-i objektis Vastus valdkonnas.
- Kasutage järgmist käsku, et saada teavet SSL.com-i CSC API teenuse kohta. Kui olete liivakastikeskkonnas, kasutage
https://cs-try.ssl.com/csc/v0/infoasemel.
curl --location --request POST "https://cs.ssl.com/csc/v0/info" \ --header "Content-Type: application / json" \ --data-raw "{}" - Teile saadetakse teenuse üksikasjadega JSON-objekt:
CSC mandaatide loend
. CSC mandaatide loend taotlus hankib mandaadi, mida kasutate hilisemates API-taotlustes.
- valima CSC mandaatide loend ja klõpsake luba Tab.
- Vali Kandja tunnus alates KASUTUSALA menüüs kleepige juurdepääsuluba Sümboolne klõpsake nuppu Saada nuppu.
- 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.
- Sisestage järgmine käsk. (Asenda MY-ACCESS-TOKEN oma tegeliku juurdepääsulubaga). Kui olete liivakasti keskkonnas, kasutage
https://cs-try.ssl.com/csc/v0/credentials/listselle asemel:
curl --location --request POST "https://cs.ssl.com/csc/v0/credentials/list" \ --header "Content-Type: application / json" \ --header "Autoriseerimine: Kandja MY- ACCESS-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.ssl.com/csc/v0/credentials/list" \ --header "Content-Type: application/json" \ --header "Autoriseerimine: kandja MY- ACCESS-TOKEN" \ --data-raw '{"clientData": "DS_ESEAL"}' - Te peaksite saama JSON-objekti koos kasutajaga seotud mandaadi ID-de loendiga. Teie loend sisaldab tõenäoliselt ühte väärtust. Kopeerige ja kleepige oma mandaadi ID tekstiredaktorisse, et seda hiljem kasutada.
CSC mandaatide teave (valikuline)
. 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.
- Vali Kandja tunnus alates KASUTUSALA menüü, seejärel kleepige juurdepääsuluba Sümboolne valdkonnas.
- Valige Keha vahekaardil ja kleepige seejärel oma mandaadi ID väärtuseks
credentialID.
- kliki Saada nuppu.
- JSON-i objekt koos teie allkirjastamise sertifikaatide ahela ja muu teabega kuvatakse Vastus valdkonnas.
- Sisestage järgmine käsk. Kui olete liivakasti keskkonnas, kasutage
https://cs-try.ssl.com/csc/v0/credentials/infoasendamaMY-ACCESS-TOKENjaMY-CREDENTIAL-IDoma tegeliku teabega:
curl --location --request POST "https://cs.ssl.com/csc/v0/credentials/info" \ --header "Content-Type: application/json" \ --header "Autoriseerimine: kandja MY- ACCESS-TOKEN" \ --data-raw '{ "credentialID": "MY-CREDENTIAL-ID", "certificates": "chain", "certInfo": true, "authInfo": true }' - Peaksite saama JSON-i objekti koos allkirjastamise sertifikaatide kettiga ja muu teabega:
Volitused volitavad
. Volitused volitavad taotlus hankib räsi allkirjastamiseks volituse.
- Alustage valimisega Volitused volitavad kollektsioonist ja klõpsates nuppu luba Tab.
- Vali Kandja tunnus alates KASUTUSALA menüü, seejärel kleepige juurdepääsuluba Sümboolne valdkonnas.
- Valige Keha vaheleht. Kleepige oma mandaadi ID
credentialIDväärtus ja räsi dokumendist, millele soovite alla kirjutadahashväärtus. Leidke ja sisestage oma autentimisrakendusest OTP ja sisestage see väärtuseksOTP, Seejärel klõpsake nuppu Saada nuppu. Märkus. Sertifikaatide pitseerimiseks pole OTP-d vaja.
- 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.
- Kasutage järgmist käsku. Asenda
MY-ACCESS-TOKEN,MY-CREDENTIAL-IDjaMY-HASHoma tegeliku teabega. Hankige oma 2FA rakendusest ühekordne parool ja selle väärtuseks on kasutamineMY-OTP. Märkus. Sertifikaatide pitseerimiseks pole OTP-d vaja.
curl --location --request POST "https://cs.ssl.com/csc/v0/credentials/authorize" \ --header "Content-Type: application/json" \ --header "Autoriseerimine: kandja MY- ACCESS-TOKEN" \ --data-raw '{ "credentialID": "MY-CREDENTIAL-ID", "numSignatures": 1, "hash": [ "MY-HASH" ], "OTP": "MY-OTP "}" - Peaksite saama oma allkirja aktiveerimisandmetega (SAD) JSON-objekti. Kopeerige ja kleepige see väärtus tekstiredaktorisse, et seda räsi allkirjastamistaotluses kasutada.
Logi Hash
Nüüd olete valmis dokumendi räsile alla kirjutama.
- valima Logi Hash kogust ja valige seejärel luba Tab.
- Vali Kandja tunnus alates KASUTUSALA menüü, seejärel kleepige juurdepääsuluba Sümboolne valdkonnas.
- Valige Keha vaheleht. Kleepige oma mandaadi ID
credentialIDväärtus, teie allkirja aktiveerimise andmed kuiSADväärtus ja räsi dokumendist, millele soovite alla kirjutadahashväärtus, siis klõpsake nuppu Saada nuppu.
- Teie allkirjaga JSON-objekt ilmub Vastus valdkonnas.
- Sisestage järgmine käsk. Asenda
MY-ACCESS-TOKEN,MY-CREDENTIAL-ID,MY-SADjaMY-HASHoma tegeliku teabega:
curl --location --request POST "https://cs.ssl.com/csc/v0/signatures/signHash" \ --header "Content-Type: application/json" \ --header "Autoriseerimine: kandja MY- ACCESS-TOKEN" \ --data-raw '{ "credentialID": "MY-CREDENTIAL-ID", "SAD": "MY-SAD", "hash": [ "MY-HASH" ], "signAlgo": "1.2.840.113549.1.1.11" }' - Te peaksite saama oma allkirja sisaldava JSON-i objekti.
Allkirjastage PDF
Lisaks dokumendi räside allkirjastamisele saate üles laadida ja alla kirjutada ka PDF-faili.
PDF-i allkirjastades töötate kahe POST-päringuga:
- 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
- Valige Laadige üles PDF-dokument ja klõpsake nuppu luba Tab.
- Vali Kandja tunnus alates KASUTUSALA menüü, seejärel kleepige juurdepääsuluba Sümboolne valdkonnas.
- Valige Päised vahekaardil ja kleepige oma mandaadi ID Väärtus kolonni.
- Valige Keha sakk ja klõpsake × kõrval
hello.pdfselle kohahoidja failinime eemaldamiseks.
- kliki Valige Fail nupp ja seejärel navigeerige faili juurde, mille soovite üles laadida.
- kliki Saada nuppu.
- Valige ja kopeerige
idväärtus vastuses, mida kasutada järgmises taotluses.
- Kasutage järgmist käsku. Asenda
MY-CREDENTIAL-ID,MY-ACCESS-TOKENja/PATH/TO/FILE.pdfoma tegeliku teabega:
curl --location --request POST "https://ds.ssl.com/v1/pdf/upload" \ --header "Credential-Id: MY-CREDENTIAL-ID" \ --header "Autoriseerimine: Kandja MY- ACCESS-TOKEN "\ --header" Content-Type: application / pdf "\ --data-binary" @ / PATH / TO / FILE.pdf "
- Saate JSON-i objekti väärtusega
id. Kopeerige see väärtus järgmises taotluses kasutamiseks.
Märkus. Nähtavate allkirjade jaoks vaadake järgmisi HTTP päringu päiseid (/v1/pdf/upload):
|
Mandaadi ID |
Võtmele määratud kordumatu mandaadi ID – kohustuslik |
|
Allkirjastamine-põhjus |
Lisa allkirjastamise põhjus lisamiseks allkirja välimuses ja ka allkirjasõnastikus – valikuline nt ma kinnitan selle dokumendi |
|
Allkirjastamise asukoht |
Allkirjastamise asukoha lisamine allkirjasõnastikku – valikuline, nt Houston, Texas |
|
Kontaktinfo |
Lisa kontaktandmed allkirjasõnastikku – valikuline, nt Telefoninumber |
|
Allkiri-väli-positsioon |
Allkirjavälja asukoht, kus kuvatakse visuaalne allkiri. Formaat on "x, y, laius, kõrgus" - valikuline |
|
Lehekülje number |
Lehekülje number, kuhu allkiri tõmmata – valikuline |
|
Käsitsi allkiri |
Base64 kodeeritud käeallkirja PNG-kujutis – valikuline |
Allkirjastage PDF-dokument
Nüüd saate PDF-failile alla kirjutada.
- Valige Laadige üles PDF-dokument ja klõpsake nuppu luba Tab.
- Vali Kandja tunnus alates KASUTUSALA menüü, seejärel kleepige juurdepääsuluba Sümboolne valdkonnas.
- Valige vahekaart Body, kleepige
idväärtus eelmises etapis ja OTP teie autentimisrakenduses, seejärel klõpsake nuppu Saada nuppu.
- PDF-andmed ilmuvad allpool Vastus valdkonnas. Valige Salvesta faili alates Salvesta vastus menüüle, siis andke failile nimi.
- Avage fail Acrobatis ja veenduge, et fail on allkirjastatud.
- Sisestage järgmine käsk. Asenda
MY-CREDENTIAL-ID,MY-FILE-IDjaOUTPUT-FILENAMEoma tegeliku teabega. Hankige oma 2FA rakendusest ühekordne parool (OTP) ja sisestage see kuiMY-OTP. Märkus. Sertifikaatide pitseerimiseks pole OTP-d vaja:
curl --location --request POST 'https://ds.ssl.com/v1/pdf/sign' \ --header 'Content-Transfer-Encoding: application / json' \ --header 'Content-type: application / json '\ --header' Autoriseerimine: kandja MINU-JUURDEPÄÄS-TOKEN '\ --data-raw' {"id": "MINU-FILE-ID", "otp": "MY-OTP"} '- -väljund OUTPUT-FILENAME - cURL laadib allkirjastatud faili alla ja salvestab teie määratud failinimesse:
- Allkirja kehtivuse kontrollimiseks avage Acrobati või Acrobat Readeri PDF-fail.
