Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

Ruby Web API Examples

Primary Categories

AWS Translate
Activix CRM
Adyen
Amazon MWS
Azure Maps
Azure Monitor
Azure OAuth2
Azure Storage Accounts
Bluzone
CardConnect
ClickBank
Clickatell
Cloudfare
DocuSign
ETrade
Etsy
Facebook
GeoOp
GetHarvest
Jira
MYOB

Magento
Microsoft Calendar
Microsoft Group
Microsoft Tasks and Plans
Okta OAuth/OIDC
OneLogin OIDC
PayPal
Peoplevox
Populi
QuickBooks
SOAP finkok.com
Shippo
Shopify
Stripe
SugarCRM
Trello
Twitter
VoiceBase
Vonage
Walmart
Walmart v3
Xero
eBay
effectconnect

 

 

 

(Ruby) DocuSign: Requesting a Signature via Email (Remote Signing)

This code example demonstrates the simplest and quickest workflow for requesting a signature for a document via email. The email will contain a signing link the recipient can use to electronically sign a document from their mobile or desktop computer.

For more information, see https://developers.docusign.com/esign-rest-api/code-examples/quickstart-request-signature-email

Chilkat Ruby Downloads

Ruby Library for Linux and MAC OS X

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

# Implements the following CURL command:

# curl --request POST https://demo.docusign.net/restapi/v2/accounts/${accountId}/envelopes \
#      --header "Authorization: Bearer ${accessToken}" \
#      --header "Content-Type: application/json" \
#      --data '{
#     "emailSubject": "Please sign this document",
#     "documents": [
#         {
#             "documentBase64": "JVBERi0xLjMKMyAwIG9iag ... dGFydHhyZWYKNjk5CiUlRU9GCg==",
#             "name": "Lorem Ipsum",
#             "fileExtension": "pdf",
#             "documentId": "1"
#         }
#     ],
#     "recipients": {
#         "signers": [
#             {
#                 "email": "joe_sample@example.com",
#                 "name": "Joe Sample",
#                 "recipientId": "1",
#                 "routingOrder": "1",
#                 "tabs": {
#                     "signHereTabs": [
#                         {
#                             "documentId": "1", "pageNumber": "1",
#                             "recipientId": "1", "tabLabel": "SignHereTab",
#                             "xPosition": "195", "yPosition": "147"
#                         }
#                     ]
#                 }
#             }
#         ]
#     },
#     "status": "sent"
# }'

# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "emailSubject": "Please sign this document",
#   "documents": [
#     {
#       "documentBase64": "JVBERi0xLjMKMyAwIG9iag ... dGFydHhyZWYKNjk5CiUlRU9GCg==",
#       "name": "Lorem Ipsum",
#       "fileExtension": "pdf",
#       "documentId": "1"
#     }
#   ],
#   "recipients": {
#     "signers": [
#       {
#         "email": "joe_sample@example.com",
#         "name": "Joe Sample",
#         "recipientId": "1",
#         "routingOrder": "1",
#         "tabs": {
#           "signHereTabs": [
#             {
#               "documentId": "1",
#               "pageNumber": "1",
#               "recipientId": "1",
#               "tabLabel": "SignHereTab",
#               "xPosition": "195",
#               "yPosition": "147"
#             }
#           ]
#         }
#       }
#     ]
#   },
#   "status": "sent"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("emailSubject","Please sign this document")
json.UpdateString("documents[0].documentBase64","JVBERi0xLjMKMyAwIG9iag ... dGFydHhyZWYKNjk5CiUlRU9GCg==")
json.UpdateString("documents[0].name","Lorem Ipsum")
json.UpdateString("documents[0].fileExtension","pdf")
json.UpdateString("documents[0].documentId","1")
json.UpdateString("recipients.signers[0].email","joe_sample@example.com")
json.UpdateString("recipients.signers[0].name","Joe Sample")
json.UpdateString("recipients.signers[0].recipientId","1")
json.UpdateString("recipients.signers[0].routingOrder","1")
json.UpdateString("recipients.signers[0].tabs.signHereTabs[0].documentId","1")
json.UpdateString("recipients.signers[0].tabs.signHereTabs[0].pageNumber","1")
json.UpdateString("recipients.signers[0].tabs.signHereTabs[0].recipientId","1")
json.UpdateString("recipients.signers[0].tabs.signHereTabs[0].tabLabel","SignHereTab")
json.UpdateString("recipients.signers[0].tabs.signHereTabs[0].xPosition","195")
json.UpdateString("recipients.signers[0].tabs.signHereTabs[0].yPosition","147")
json.UpdateString("status","sent")

http.SetRequestHeader("Authorization","Bearer ${accessToken}")
http.SetRequestHeader("Content-Type","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://demo.docusign.net/restapi/v2/accounts/${accountId}/envelopes","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "envelopeId": "d51cfdab-22ed-4832-bf68-446c44077ffc",
#   "uri": "/envelopes/d51cfdab-22ed-4832-bf68-446c44077ffc",
#   "statusDateTime": "2018-04-17T16:31:51.8830000Z",
#   "status": "sent"
# }

# Sample code for parsing the JSON response...
# Use the following online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

envelopeId = jResp.stringOf("envelopeId")
uri = jResp.stringOf("uri")
statusDateTime = jResp.stringOf("statusDateTime")
status = jResp.stringOf("status")

 

© 2000-2019 Chilkat Software, Inc. All Rights Reserved.