Skip to navigation
SDKs

Ruby SDK

View as Markdown

The Ruby eSignature SDK is provided by Docusign to help Ruby developers use the Docusign eSignature REST API. It is provided as both a Ruby gem and an open source repo on GitHub. The Ruby eSignature SDK is also used when developers opt to get started with the Ruby Quickstart, which generates ready-to-use, personalized Ruby code.

Places to start

Setup and configurationAuthenticationSDK reference

Compatibility

  • The Ruby eSignature SDK is compatible with Ruby 1.9 and later.
  • The Ruby eSignature SDK package is dependent on other Ruby packages. The list of dependencies can be found on the docusign_esign RubyGems page. Next to each dependency is the minimum version required for that package.

SDK versions

New versions of the SDK are released periodically to use the latest version of the eSignature REST API. SDK versions use the standard period-separated software versioning scheme. General release versions are of the form x.y.z, and release candidate (prerelease) versions are of the form x.y.z.rc.

The SDK’s changelog file lists each SDK update and its notable changes from the prior version.

Developers are not required to update their applications to new versions of the SDK, unless there’s a specific reason to do so:

  • Access to a new eSignature API feature or method
  • An SDK bug fix including security-related issues
  • To support an updated version of one of the SDK’s dependencies

SDK Issues

If you find any issues with the SDKs, you can open an issue on the GitHub repo, or reach out to Support.