Module: HelloSign::Api::Embedded

Included in:
Client
Defined in:
lib/hello_sign/api/embedded.rb

Overview

HelloSign allows you to embed the signing page on your site in an iFrame without the need for the end-user to create a HelloSign account. Take a look at our embedded signing walkthrough for more information about this.

Author:

  • hellosign

Instance Method Summary collapse

Instance Method Details

#get_embedded_sign_url(opts) ⇒ HelloSign::Resource::Embedded

Retrieves the embedded signature request url.

Examples:

embedded = @client.get_embedded_sign_url :signature_id => '50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b'

Parameters:

  • opts (Hash) —

    a customizable set of options

Options Hash (opts):

  • signature_id (String) —

    The id of the signature to get a signature url for

Returns:



46
47
48
 
# File 'lib/hello_sign/api/embedded.rb', line 46

def get_embedded_sign_url(opts)
  HelloSign::Resource::Embedded.new get("/embedded/sign_url/#{opts[:signature_id]}")
end

#get_embedded_template_edit_url(opts) ⇒ HelloSign::Resource::Embedded

Retrieves the edit url for an embedded template.

Examples:

edit_url = @client.get_embedded_template_edit_url :template_id => '39e3387f738adfa7ddd4cbd4c00d2a8ab6e4194b'

Parameters:

  • opts (Hash) —

    a customizable set of options

Options Hash (opts):

  • template_id (String) —

    The id of the template to get a edit url for

  • skip_signer_roles (Integer) —

    Whether editing signer roles should be skipped

  • skip_subject_message (Integer) —

    Whether editing subject/message should be skipped

Returns:



59
60
61
62
63
64
 
# File 'lib/hello_sign/api/embedded.rb', line 59

def get_embedded_template_edit_url(opts)
  defaults = { :skip_signer_roles => 0, :skip_subject_message => 0, :test_mode => 0 }
  opts = defaults.merge(opts)

  HelloSign::Resource::Embedded.new get("/embedded/edit_url/#{opts[:template_id]}?skip_signer_roles=#{opts[:skip_signer_roles]}&skip_subject_message=#{opts[:skip_subject_message]}&test_mode=#{opts[:test_mode]}")
end