Ръководство за интеграция за тестване на отдалечено подписване на документи с eSigner CSC API

Това ръководство ще ви води през подписване на хеш на документ и PDF файл с SSL.com eSigner услуга за подписване в облак и API на Cloud Signature Consortium (CSC). Всички примери за заявки за API ще бъдат показани с пощаджияи препоръчваме да инсталирате Настолно приложение за пощальон на вашия компютър, ако искате да работите с примерите. Включени са и примери за команди cURL на заявките за API.

Това ръководство обхваща използването на CSC API в SSL.com пясък среда за тестване, така че можете да се чувствате свободни да експериментирате с API, без да се притеснявате за таксуване. Моля, обърнете се към нашия Ръководство за пясъчник за инструкции за настройване на вашия акаунт в Sandbox.

Ако сте готови да работите с CSC API в производствената среда на eSigner на SSLcom, моля, прочетете Отдалечено подписване на документи с eSigner CSC API.

Създайте тестова поръчка

  1. Първо, ще трябва да създадете ред за подписване на документи в пясъчника. Започнете, като влезете в акаунта си в Sandbox и отидете на Табло раздела.
    Табло за управление на пясъчника
  2. Кликнете инструменти за разработчици.
    инструменти за разработчици
  3. Изберете eSigner Подписване на документи, след което кликнете върху Създайте тестова поръчка бутон.
  4. Ще се появи диалогов прозорец. Щракнете върху OK бутон.
  5. Намерете вашата тестова поръчка, след което щракнете върху детайли връзка.
    подробна връзка
  6. Кликнете редактиране на регистрант за да започнете да въвеждате информация за кандидат и получател за вашата поръчка за тестване. Имайте предвид, че тъй като тази информация няма да се използва за издаване на валиден сертификат за подписване на документи, можете да въведете фиктивна информация, ако желаете.
    редактиране на регистрант
  7. Добавете информация за кандидат за сертификат за тест, след което щракнете върху Напред >> бутон.
    Информация за кандидата
  8. Въведете информация за получателя, след което щракнете върху Напред >> бутон.
    информация за получателя
  9. Щракнете върху Пропусни бутон за пропускане на качване на документи за проверка на сертификата за тест.
    Бутон за пропускане
  10. Вашата пробна поръчка вече трябва да има статус на в очакване на валидиране. Свържете се с екипа за поддръжка на SSL.com на адрес Support@SSL.com за да бъде валидиран сертификатът ви за тест.
    в очакване на валидиране

Запишете се в eSigner и настройте двуфакторно удостоверяване

  1. След като вашата тестова поръчка бъде потвърдена от поддръжката на SSL.com, можете да я регистрирате в eSigner. Придвижете се до Поръчки в своя акаунт в пясъчник на SSL.com и намерете вашата тестова поръчка.
    Придвижете се до поръчката
  2. Щракнете върху поръчките детайли връзка.
    подробна връзка
  3. Създайте и потвърдете 4-цифрен ПИН, след което щракнете върху създайте ПИН бутон.
    Ако трябва да нулирате своя eSigner ПИН, моля, прочетете това как да.
    Създайте ПИН
  4. Ще се появи QR код.
    Следващият път, когато презаредите страницата, QR кодът няма да се вижда. Ако трябва да прегледате или нулирате своя QR код на eSigner, моля, прочетете това как да.
    QR Code
  5. Сканирайте кода в 2-факторно приложение за удостоверяване на вашето мобилно устройство, като Google Authenticator или Authy. Приложението ще ви предостави еднократни пароли (OTP), които да използвате при подписване. Всеки OTP е валиден за 30 секунди.
    OTP в Authy

инсталирам пощаджия и Импортиране на CSC API колекция

  1. Изтеглете и разархивирайте Колекция CSC API Postman (Вж. https://www.postman.com/sslcom/workspace/public/collection/3420801-f2df0995-1293-45da-8719-73467c9f0ca7?ctx=documentation за най-новите крайни точки на API или изтегляния на колекция).
    Колекция пощальон на API на CSC
  2. Изтеглете и инсталирайте Пощальон REST клиент.
    Изтегляне на пощальон REST Client
  3. Стартирайте Postman, след това създайте нов акаунт в Postman или влезте в съществуващ.
    Влизане на пощальон
  4. Щракнете върху внос бутон.
    Бутон за импортиране
  5. Щракнете върху Качване на файлове , отидете до разархивирания файл за събиране на API (CSC-API.postman_collection.json) и го отворете.
    Качване на файлове
  6. Щракнете върху внос бутон.
    Бутон за импортиране
  7. Щракнете върху колекции в раздела Postman и разширете CSC API колекцията, за да видите петте POST заявки, с които ще работите:
    • Информация за CSC
    • Списък с идентификационни данни на CSC
    • CSC идентификационни данни Информация
    • Удостоверения за пълномощия
    • Подпишете хеш

    CSC API колекция

Изтеглете токена за достъп

  1. Следващата стъпка е да извлечете токен за достъп от SSL.com. Преди да поискате вашия маркер за достъп, ще ви трябва Клиентски идентификационен номер (известен също като Идент. № на приложението. Моля, обърнете се към това как да за инструкции за генериране на тези идентификационни данни).
  2. Изберете Упълномощаване , изберете OAuth 2.0 от Тип и щракнете върху Вземете нов маркер за достъп бутон.
    Вземете нов маркер за достъп
  3. Въведете следната информация във формуляра:
    • Име на токена: SandBox CSC (или друго лесно за запомняне име, което предпочитате)
    • Тип безвъзмездна помощ: Код за разрешение
    • URL адрес за обратно извикване: [остави празно]
    • Оторизирайте с помощта на браузър: проверено
    • URL за удостоверяване: https://oauth-sandbox.ssl.com/oauth2/authorize
    • URL за достъп до маркера: https://oauth-sandbox.ssl.com/oauth2/token
    • Идент. № на клиента: [Вашият клиентски идентификатор]
    • Клиентска тайна: [Вашата клиентска тайна]
    • Обхват: обслужване
    • членка: [остави празно]
    • Клиентско удостоверяване: Изпращане като заглавка на Basic Auth

    Когато приключите, щракнете върху Заявете токен бутон.
    Вземете нов маркер за достъп

  4. Формата за вход ще се появи във вашия уеб браузър. Въведете вашето потребителско име и парола за SSL.com, след което щракнете върху Вход бутон.
    Формуляр за вход в акаунт
  5. Новият ви маркер за достъп трябва да се появи в Postman. Изберете текста на маркера за достъп и го копирайте в клипборда, след което затворете Управление на маркерите за достъп диалогов прозорец. Поставете маркера си за достъп в текстов редактор, където можете лесно да го осъществите. Всеки маркер за достъп ще изтече след един час.
    Можете също да запазите своя токен за повторна употреба пощаджия заявки, но установихме, че е най-надеждно да копирате и поставите токена директно във всяка заявка.
    Token Access

Подпишете хеш

Сега, когато имате токен за достъп, можете да започнете да правите заявки за API и да създавате подписи. Този раздел ще ви преведе през петте налични заявки в Колекция CSC пощальон, което води до създаване на цифров подпис от хеш на документ.

Вземете информация за CSC (по избор)

  1. Можете да използвате Информация за CSC заявка за получаване на информация за услугата за подписване в облак на SSL.com. Имайте предвид, че за разлика от останалите в колекцията, тази заявка не изисква вашия маркер за достъп. За да изпратите заявката, изберете Информация за CSC от API на CSC колекция, след това щракнете върху Изпрати бутон.
    Заявка за информация от CSC
  2. Информацията за услугата за подпис в облака ще се появи в обект JSON в Postman's Отговор поле.
    Информация за CSC

Команда CURL

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

Списък с идентификационни данни на CSC

  1. Списък с идентификационни данни на CSC заявка ще извлече идентификационни данни, които ще използвате в по-късните заявки за API. Изберете Списък с идентификационни данни на CSC и кликнете върху Упълномощаване раздела.
    Списък с идентификационни данни на CSC
  2. Изберете Жетон на приносител от Тип меню, поставете маркера за достъп в Жетон след това щракнете върху Изпрати бутон.
    Добавете токен и изпратете заявка
  3. JSON обект със списък с идентификационни данни за идентификационни данни, свързани с потребителя, ще се появи в Отговор поле. Списъкът ви вероятно ще съдържа една стойност. Копирайте и поставете идентификационния си идентификационен номер в текстов редактор за използване при по-късни заявки.
    Идентификационен номер на идентификационни данни

Команда CURL

Сменете MY-ACCESS-TOKEN с вашия действителен маркер за достъп:

curl --location --request POST "https://cs-try.ssl.com/csc/v0/credentials/list" \ --header "Тип съдържание: application / json" \ --header "Разрешение: Носител MY-ACCESS-TOKEN "\ --data-raw" {} "

Ако използвате сертификат eseal (сертификат за подписване на документи само с информация за организацията; включен във вашия безплатен акаунт в esigner.com), включете „clientData“: „DS_ESEAL“ (забележка: eseals не изисква OTP удостоверяване). Други опции за „clientData“ са „EVCS“ за подписване на EV код и „DS“ (по подразбиране) за IV или IV+OV подписване на документи:

curl --location --request POST "https://cs-try.ssl.com/csc/v0/credentials/list" \ --header "Content-Type: application/json" \ --header "Упълномощаване: Носител МОЯТ-ДОСТЪП-ТОКЕН" \ --data-raw "{\"clientData\": \"DS_ESEAL\"}"

Информация за идентификационните данни на CSC (по избор)

  1. - CSC идентификационни данни Информация заявката ще върне сертификати и друга информация, свързана с идентификационен номер на идентификационните данни, и не е необходима за подписване. За да използвате тази заявка, изберете CSC идентификационни данни Информация от колекцията и щракнете върху Упълномощаване раздела.
    CSC идентификационни данни Информация
  2. Изберете Жетон на приносител от Тип меню, след това поставете маркера за достъп в Жетон поле.
    поставете токен за упълномощаване
  3. Изберете Body раздела, след това поставете идентификационния си номер като стойност за credentialID.
    Въведете идентификационен номер на идентификационните данни
  4. Щракнете върху Изпрати бутон.
    Щракнете върху бутона за изпращане
  5. JSON обект с вашата верига за подписване на сертификати и друга информация ще се появи в Отговор поле.
    Информация за идентификационни данни за идентификационни данни

Команда CURL

Сменете MY-ACCESS-TOKEN намлява MY-CREDENTIAL-ID с вашата действителна информация:

curl --location --request POST "https://cs-try.ssl.com/csc/v0/credentials/info" \ --header "Тип съдържание: application / json" \ --header "Разрешение: Носител MY-ACCESS-TOKEN "\ --data-raw" {\ "credentialID \": \ "MY-CREDENTIAL-ID \", \ "сертификати \": \ "верига \", \ "certInfo \": true, \ "authInfo \": вярно} "

Удостоверения за пълномощия

  1. - Удостоверения за пълномощия заявката ще извлече разрешение за подписване на хеш. Започнете, като изберете Удостоверения за пълномощия от колекцията и щракване върху Упълномощаване раздела.
    Удостоверения за пълномощия
  2. Изберете Жетон на приносител от Тип меню, след това поставете маркера за достъп в Жетон поле.
    лепенка за поставяне
  3. Изберете Body раздел. Поставете идентификационния си номер като credentialID стойност и хеш на документа, който искате да подпишете като hash стойност. Изтеглете и въведете OTP от приложението си за удостоверяване и го въведете като стойност за OTP, след което кликнете върху Изпрати бутон.
    въведете идентификационни данни за идентификационни данни, хеш и OTP
  4. JSON обект с вашите данни за активиране на подпис (SAD) ще се появи в Отговор поле. Копирайте и поставете тази стойност в текстов редактор за използване в заявката за подписване на хеш.
    ЕАД

Команда CURL

Сменете MY-ACCESS-TOKENMY-CREDENTIAL-ID, MY-HASH, и MY-OTP с вашата действителна информация:

curl --location --request POST "https://cs-try.ssl.com/csc/v0/credentials/authorize" \ --header "Тип съдържание: application / json" \ --header "Разрешение: Приносител MY-ACCESS-TOKEN "\ --data-raw" {\ "credentialID \": \ "MY-CREDENTIAL-ID \", \ "numSignatures \": 1, \ "hash \": [\ "MY-HASH \ "], \" OTP \ ": \" МОЙ-OTP \ "}"

Подпишете хеш

  1. Сега сме готови да подпишем хеша на документа. Изберете Подпишете хеш от колекцията, след което изберете Упълномощаване раздела.
    Подпишете хеш
  2. Изберете Жетон на приносител от Тип меню, след това поставете маркера за достъп в Жетон поле.
    лепенка за поставяне
  3. Изберете Body раздел. Поставете идентификационния си номер като credentialID стойност, вашите данни за активиране на подпис като SAD стойност и хеш на документа, който искате да подпишете като hash стойност, след което щракнете върху Изпрати бутон.
    Поставете SAD и хеш, изпратете заявка
  4. JSON обект с вашия подпис ще се появи в Отговор поле.
    подпис

Команда CURL

Сменете MY-ACCESS-TOKENMY-CREDENTIAL-ID, MY-SAD, и MY-HASH с вашата действителна информация:

curl --location --request POST "https://cs-try.ssl.com/csc/v0/signatures/signHash" \ --header "Тип съдържание: application / json" \ --header "Разрешение: Приносител MY-ACCESS-TOKEN "\ --data-raw" {\ "credentialID \": \ "MY-CREDENTIAL-ID \", \ "SAD \": \ "MY-SAD \", \ "hash \": [\ "MY-HASH \"], \ "signAlgo \": \ "1.2.840.113549.1.1.11 \"} "

Подпишете PDF

В допълнение към подписването на хешове на документи, можете също да качите и подпишете PDF файл. Започнете, като изтеглите и импортирате API за подписване на документи Колекция пощальон (Вж. https://www.postman.com/sslcom/workspace/public/collection/3454644-277d8427-f749-4a94-93bf-c3478b79b999?ctx=documentation за най-новите крайни точки на API и изтегляния на колекция), следвайки същото стъпки за инсталиране последвахте по -горе за колекцията от CSC API.

OTP разрешение не се изисква при подписване с помощта на сертификат за подписване на документ за повторно запечатване. Игнорирайте всички OTP параметри в следното ръководство, ако използвате сертификат за подписване на документ за повторно запечатване. (Клиенти със съществуващ Сертификат за подписване на документ за валидиране на организацията може да се свърже support@ssl.com за да бъде преобразуван в сертификат за eSealing.)
Когато подписвате PDF, ще работите с две POST заявки:

  • Качете PDF документ
  • Подпишете PDF документ

Колекция от API за подписване на документи

Можете да използвате повторно идентификационните данни, които сте получили по-горе, с Списък с идентификационни данни на CSC заявка. Вероятно ще трябва да изтеглите нов знак за достъп.

Качете PDF документ

  1. Изберете Качете PDF документ заявка и щракнете върху Упълномощаване раздела.
    Качете PDF документ
  2. Изберете Жетон на приносител от Тип меню, след това поставете маркера за достъп в Жетон поле.
    Поставете маркера
  3. Изберете Заглавия и поставете идентификационния си идентификационен номер в Стойност колона.
    добавете идентификационен номер на идентификатор към заглавката
  4. Изберете Body и кликнете върху × до hello.pdf за да премахнете това име на файл с резервни части.
    премахване на резервен файл
  5. Щракнете върху Избери файл , след което отидете до файла, който искате да качите.
    Избери файл
  6. Щракнете върху Изпрати бутон.
    Изпрати заявка
  7. Изберете и копирайте id стойност в отговора за използване в следващата заявка.
    идентификатор на файла

команда cURL

Сменете MY-CREDENTIAL-ID, MY-ACCESS-TOKEN, и /PATH/TO/FILE.pdf с вашата действителна информация:

curl --location --request POST "https://ds-try.ssl.com/v1/pdf/upload" \ --header "Credential-Id: MY-CREDENTIAL-ID" \ --header "Разрешение: Приносител MY-ACCESS-TOKEN "\ --header" Тип съдържание: application / pdf "\ --data-binary" @ / PATH / TO / FILE.pdf "

Забележка: За видими подписи, моля, вижте следните заглавки на HTTP заявка (/v1/pdf/upload):

Заглавка на заявката

Описание

Credential-Id

Уникален идентификационен номер, присвоен на ключа – Задължително

Подписване-причина

Добавете причина за подписване, за да добавите във външния вид на подписа, а също и в речника на подписите – по избор, напр. одобрявам този документ

Подписване-местоположение

Добавете място за подписване в речника за подписи – по избор, напр. Хюстън, Тексас

Информация за контакт

Добавете информация за контакт в речника за подписи – по избор, напр. телефонен номер

Подпис-Поле-Позиция

Позиция на полето за подпис, където се показва визуалният подпис. Форматът е „x,y, ширина, височина“ - По избор

Номер на страницата

Номер на страницата, където да се начертае подпис – по избор

Подпис на ръка

Base64 кодирано PNG изображение на подпис на ръка – по избор




Подпишете PDF документ

  1. Сега можете да подпишете PDF файла. Изберете Качете PDF документ заявка и щракнете върху Упълномощаване раздела.
      
  2. Изберете Жетон на приносител от Тип меню, след това поставете маркера за достъп в Жетон поле.
    лепенка за поставяне
  3. Изберете раздела Body и поставете в id стойност от предишната стъпка.
    въведете ID
  4. Въведете OTP от приложението си за удостоверяване и щракнете върху Изпрати бутон.
    въведете OTP и щракнете върху Изпрати
  5. PDF данните ще се покажат по-долу в Отговор поле. Избирам Запазване във файл от Запазване на отговора меню, след това дайте име на файла.
    Запазване в файл
  6. Отворете файла в Acrobat, за да потвърдите, че файлът е подписан. (Обърнете внимание, че на екранната снимка по-долу коренът на RSA Development на SSL.com е доверен ръчно в Acrobat.)
    цифров подпис в Adobe Acrobat

Команда CURL

Сменете MY-CREDENTIAL-ID, MY-FILE-ID, и MY-OTP с вашата действителна информация:

curl --location --request POST "https://ds-try.ssl.com/v1/pdf/sign" \ --header "Content-Transfer-Encoding: application / json" \ --header "Content-Type : application / json "\ --header" Упълномощаване: Приносител MY-ACCESS-TOKEN "\ --data-raw" {\ "id \": \ "MY-FILE-ID \", \ "otp \": \ "MY-OTP \"} "

 Излизане на живо с продукция

За да стартирате на живо, трябва да премахнете „-пробвайте“ от поддомейна. Например, за да стартирате на живо с ds-try.ssl.com, премахнете „-try“, така че поддомейнът да стане ds.ssl.com.

Потребителите могат да подписват код с възможността за подписване на код за разширена валидация на eSigner. Щракнете по-долу за повече информация.

НАУЧЕТЕ ПОВЕЧЕ

Twitter
Facebook
LinkedIn
Reddit
Имейл

Бъдете информирани и защитени

SSL.com е глобален лидер в киберсигурността, PKI и цифрови сертификати. Регистрирайте се, за да получавате най-новите новини от индустрията, съвети и съобщения за продукти от SSL.com.

Ще се радваме на вашите отзиви

Попълнете нашата анкета и ни кажете какво мислите за скорошната си покупка.