en English
X

Select Language

Powered by Google TranslateTranslate

We hope you will find the Google translation service helpful, but we don’t promise that Google’s translation will be accurate or complete. You should not rely on Google’s translation. English is the official language of our site.

en English
X

Select Language

Powered by Google TranslateTranslate

We hope you will find the Google translation service helpful, but we don’t promise that Google’s translation will be accurate or complete. You should not rely on Google’s translation. English is the official language of our site.

Integration Guide to Testing Remote Signing with eSigner CSC API

This guide will lead you through signing a document hash and PDF file with SSL.com’s eSigner cloud signing service and the Cloud Signature Consortium (CSC) API. All API request examples will be shown with Postman, and we recommend installing the Postman desktop app on your computer if you want to work through the examples. cURL command examples of the API requests are also included.

This guide covers use of the CSC API in SSL.com’s Sandbox testing environment, so you can feel free to experiment with the API without worrying about getting billed. Please refer to our Sandbox guide for instructions on setting up your Sandbox account.

If you’re ready to work with the CSC API in SSLcom’s production eSigner environment, please read Remote Document Signing with eSigner CSC API.

Create a Test Order

  1. First, you’ll need to create a document signing order in the Sandbox. Begin by signing into your Sandbox account and going to the Dashboard tab.
    Sandbox Dashboard
  2. Click developer tools.
    developer tools
  3. Select Personal Business, then click the Create Test Order button.
    Create Test Order
  4. A dialog box will appear. Click the OK button.
  5. Locate your test order, then click the details link.
    details link
  6. Click edit registrant to begin entering applicant and recipient information for your test order. Note that since this information will not be used to issue a valid document signing certificate, you can enter fictitious information if desired.
    edit registrant
  7. Add applicant information for the test certificate, then click the Next>> button.
    Applicant Information
  8. Enter recipient information, then click the Next>> button.
    recipient information
  9. Click the Skip button to skip uploading validation documents for the test certificate.
    Skip button
  10. Your test order should now have a status of pending validation. Contact the SSL.com support team at Support@SSL.com to have your test certificate validated.
    pending validation

Enroll in eSigner and Set Up Two-Factor Authentication

  1. Once your test order has been validated by SSL.com support staff, you can enroll it in eSigner. Navigate to the Orders tab in your SSL.com sandbox account and locate your test order.
    Navigate to order
  2. Click the order’s details link.
    details link
  3. Create and confirm a 4-digit PIN, then click the create PIN button.
    Create PIN
  4. A QR code will appear.
    QR code
  5. Scan the code into a 2-factor authentication app on your mobile device, such as Google Authenticator or Authy. The app will provide you with one-time passwords (OTPs) for use when signing. Each OTP is valid for 30 seconds.
    OTP in Authy

Install Postman and Import CSC API Collection

  1. Download and unzip the CSC API Postman collection.
    CSC API Postman Collection
  2. Download and install the Postman REST Client.
    Postman REST Client download
  3. Launch Postman, then create a new Postman account or sign into an existing one.
    Postman Login
  4. Click the Import button.
    Import button
  5. Click the Upload Files button, navigate to the unzipped API collection file (CSC-API.postman_collection.json), and open it.
    Upload Files
  6. Click the Import button.
    Import button
  7. Click the Collections tab in Postman and expand the CSC API collection to view the five POST requests you will be working with:
    • CSC Info
    • CSC Credentials List
    • CSC Credentials Info
    • Credentials Authorize
    • Sign Hash

    CSC API Collection

Retrieve Access Token

  1. The next step is to retrieve an access token from SSL.com. Before you request your access token, you will need a Client ID and Client Secret. Please contact Support@SSL.com for these credentials.
  2. Select the Authorization tab, select OAuth 2.0 from the Type menu, and click the Get New Access Token button.
    Get New Access Token
  3. Enter the following information into the form:
    • Token Name: SandBox CSC (or any other easy-to-remember name that you prefer)
    • Grant Type: Authorization Code
    • Callback URL: [leave blank]
    • Authorize using browser: checked
    • Auth URL: https://oauth-sandbox.ssl.com/oauth2/authorize
    • Access Token URL: https://oauth-sandbox.ssl.com/oauth2/token
    • Client ID: [Your Client ID]
    • Client Secret: [Your Client Secret]
    • Scope: service
    • State: [leave blank]
    • Client Authentication: Send as Basic Auth header

    When you are finished, click the Request Token button.
    Get New Access Token

  4. A login form will appear in your web browser. Enter your SSL.com username and password, then click the Member Login button.
    Account Login Form
  5. Your new access token should appear in Postman. Select the access token text and copy it to the clipboard, then close the Manage Access Tokens dialog box. Paste your access token into a text editor where you can access it easily. Each access token will expire after one hour.
    You can also save your token for re-use in Postman requests, but we have found that it is most reliable to copy and paste the token directly into each request.
    Access Token

Sign a Hash

Now that you have an access token, you can begin making API requests and creating signatures. This section will lead you through the five available requests in the Postman CSC collection, resulting in the creation of a digital signature from a document hash.

Get CSC Info (Optional)

  1. You can use the CSC Info request to get information about SSL.com’s cloud signature service. Note that, unlike the others in the collection, this request does not require your access token. To send the request, select CSC Info from the CSC API collection, then click the Send button.
    CSC Info Request
  2. Information about the cloud signature service will appear in a JSON object in Postman’s Response field.
    CSC Info

cURL Command

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

CSC Credentials List

  1. The CSC Credentials List request will retrieve a credential you will use in later API requests. Select CSC Credentials List and click the Authorization tab.
    CSC Credentials List
  2. Choose Bearer Token from the Type menu, paste your access token into the Token field, then click the Send button.
    Add token and send request
  3. A JSON object with a list of credential IDs associated with the user will appear in the Response field. Your list will probably contain one value. Copy and paste your credential ID into a text editor for use in later requests.
    Credential ID

cURL Command

Replace MY-ACCESS-TOKEN with your actual access token:

curl --location --request POST 'https://cs-try.ssl.com/csc/v0/credentials/list' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer MY-ACCESS-TOKEN' \
--data-raw '{}'

CSC Credentials Info (Optional)

  1. The CSC Credentials Info request will return certificates and other information associated with a credential ID, and is not required for signing. To use this request, select CSC Credentials Info from the collection and click the Authorization tab.
    CSC Credentials Info
  2. Choose Bearer Token from the Type menu, then paste your access token into the Token field.
    paste authorization token
  3. Select the Body tab, then paste your credential ID as the value for credentialID.
    Enter credential ID
  4. Click the Send button.
    Click send button
  5. A JSON object with your signing certificate chain and other information will appear in the Response field.
    Credential ID info

cURL Command

Replace MY-ACCESS-TOKEN and MY-CREDENTIAL-ID with your actual information:

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

Credentials Authorize

  1. The Credentials Authorize request will retrieve authorization for signing a hash. Begin by selecting Credentials Authorize from the collection and clicking the Authorization tab.
    Credentials Authorize
  2. Choose Bearer Token from the Type menu, then paste your access token into the Token field.
    paste token
  3. Select the Body tab. Paste your credential ID as the credentialID value and a hash of the document you wish to sign as the hash value. Retrieve and enter an OTP from your authentication app and enter it as the value for OTP, then click the Send button.
    enter credential id, hash, and OTP
  4. A JSON object with your Signature Activation Data (SAD) will appear in the Response field. Copy and paste this value into a text editor for use in the hash signing request.
    SAD

cURL Command

Replace MY-ACCESS-TOKENMY-CREDENTIAL-ID, MY-HASH, and MY-OTP with your actual information:

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

Sign Hash

  1. Now we’re ready to sign the document hash. Select Sign Hash from the collection, then select the Authorization tab.
    Sign Hash
  2. Choose Bearer Token from the Type menu, then paste your access token into the Token field.
    paste token
  3. Select the Body tab. Paste your credential ID as the credentialID value, your Signature Activation Data as the SAD value, and a hash of the document you wish to sign as the hash value, then click the Send button.
    Paste SAD and hash, send request
  4. A JSON object with your signature will appear in the Response field.
    signature

cURL Command

Replace MY-ACCESS-TOKENMY-CREDENTIAL-ID, MY-SAD, and MY-HASH with your actual information:

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

Sign a PDF

In addition to signing document hashes, you can also upload and sign a PDF file. Begin by downloading and importing the Document Signing API Postman collection, following the same installation steps you followed above for the CSC API collection. When signing a PDF you will be working with two POST requests:

  • Upload PDF Document
  • Sign PDF Document

Document Signing API Collection

You can re-use the credential you retrieved above with the CSC Credentials List request. You will probably also need to retrieve a new access token.

Upload PDF Document

  1. Select the Upload PDF Document request and click the Authorization tab.
    Upload PDF Document
  2. Choose Bearer Token from the Type menu, then paste your access token into the Token field.
    Paste token
  3. Select the Headers tab and paste your credential ID in the Value column.
    add credential ID to header
  4. Select the Body tab and click the × next to hello.pdf to remove this placeholder filename.
    remove placeholder file
  5. Click the Select File button, then navigate to the file you want to upload.
    Select File
  6. Click the Send button.
    Send request
  7. Select and copy the id value in the response to use in the next request.
    file ID

cURL command

Replace MY-CREDENTIAL-ID, MY-ACCESS-TOKEN, and /PATH/TO/FILE.pdf with your actual information:

curl --location --request POST 'https://ds-try.ssl.com/v1/pdf/upload' \
--header 'Credential-Id: MY-CREDENTIAL-ID' \
--header 'Authorization: Bearer MY-ACCESS-TOKEN' \
--header 'Content-Type: application/pdf' \
--data-binary '@/PATH/TO/FILE.pdf'

Sign PDF Document

  1. Now you can sign the PDF. Select the Upload PDF Document request and click the Authorization tab.
      
  2. Choose Bearer Token from the Type menu, then paste your access token into the Token field.
    paste token
  3. Select the Body tab, and paste in the id value from the previous step.
    enter ID
  4. Enter an OTP from your authentication app and click the Send button.
    enter OTP and click Send
  5. The PDF data will appear below in the Response field. Choose Save to a File from the Save Response menu, then give the file a name.
    Save to a file
  6. Open the file in Acrobat to confirm that the file has been signed. (Note that in the screenshot below, SSL.com’s RSA Development root has been manually trusted in Acrobat.)
    digital signature in Adobe Acrobat

cURL Command

Replace MY-CREDENTIAL-ID, MY-FILE-ID, and MY-OTP with your actual information:

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

 

 

Share on twitter
Twitter
Share on facebook
Facebook
Share on linkedin
LinkedIn
Share on reddit
Reddit
Share on email
Email