The Official DocuSign eSignature Ruby Client SDK

[![RubyGems version][rubygems-image]][rubygems-url] [![RubyGems downloads][downloads-image]][downloads-url] [![Build status][travis-image]][travis-url]

Requirements

Compatibility

  • Ruby 1.9+

Installation

This SDK is provided as open source, which enables you to customize its functionality to suit your particular use case. To do so, download or clone the repository. If the SDK’s given functionality meets your integration needs, or if you’re working through our code examples from the DocuSign Developer Center, you merely need to install it by following the instructions below.

Installation via your application's Gemfile:

  1. In your application's Gemfile, add:
    gem 'docusign_esign'
  2. Open your preferred console.
  3. In your project directory, execute the installer by typing: bundle install

Manual installation:

  1. Open your preferred console.
  2. In the console, type: gem install docusign_esign

Dependencies

This client has the following external dependencies:

  • Jwt>=1.5.2
  • Json>=2.1.0
  • Typhoeus>=1.0.1

Code examples

You can find on our GitHub a self-executing package of code examples for the eSignature C# SDK, called a Launcher, that demonstrates common use cases. You can also download a version preconfigured for your DocuSign developer account from Quickstart. These examples can use either the Authorization Code Grant or JSON Web Token (JWT) authentication workflows.

OAuth implementations

For details regarding which type of OAuth grant will work best for your DocuSign integration, see Choose OAuth Type in the DocuSign Developer Center.

For security purposes, DocuSign recommends using the Authorization Code Grant flow.

Support

Log issues against this client through GitHub. We also have an active developer community on Stack Overflow.

License

The DocuSign eSignature Ruby Client SDK is licensed under the MIT License.

Additional resources