OAuth Walkthrough

$client = new HelloSign\Client('0ca97430f712bd3898e782000d4387c60c464155afbdb49d1fddda27c7443b98');
$client->isAccountValid('jack@example.com');

HelloSignClient client = new HelloSignClient("0ca97430f712bd3898e782000d4387c60c464155afbdb49d1fddda27c7443b98");
if (client.isAccountValid("jack@example.com")) {
    // Account is valid
}

client = HSClient(api_key='0ca97430f712bd3898e782000d4387c60c464155afbdb49d1fddda27c7443b98')
client.verify_account('jack@example.com')

client = HelloSign::Client.new :api_key => '0ca97430f712bd3898e782000d4387c60c464155afbdb49d1fddda27c7443b98'
client.verify :email_address => 'jack@examples.com'

const hellosign = require('hellosign-sdk')({ key: '0ca97430f712bd3898e782000d4387c60c464155afbdb49d1fddda27c7443b98' });

hellosign.account.verify({
  email_address: 'alice@example.com'
}).then((res) => {
  // handle response
}).catch((err) => {
  // handle error
});

var client = new Client("0ca97430f712bd3898e782000d4387c60c464155afbdb49d1fddda27c7443b98");
var account = client.VerifyAccount("jack@example.com");

$client = new HelloSign\Client('0ca97430f712bd3898e782000d4387c60c464155afbdb49d1fddda27c7443b98');
$request = new HelloSign\OAuthTokenRequest(array(
    'code' => '1b0d28d90c86c141',
    'state' => '900e06e2',
    'client_id' => 'YOUR_CLIENT_ID',
    'client_secret' => 'YOUR_CLIENT_SECRET'
));
$token = $client->requestOAuthToken($token_request);

HelloSignClient client = new HelloSignClient("0ca97430f712bd3898e782000d4387c60c464155afbdb49d1fddda27c7443b98");
String code = "1b0d28d90c86c141";
String clientId = "cc91c61d00f8bb2ece1428035716b";
String clientSecret = "1d14434088507ffa390e6f5528465";
OauthData oauth = client.getOauthData(code, clientId, clientSecret);
String token = oauth.getAccessToken();
}

client = HSClient(api_key='0ca97430f712bd3898e782000d4387c60c464155afbdb49d1fddda27c7443b98')
client.get_oauth_data(
    client_id='cc91c61d00f8bb2ece1428035716b',
    client_secret='1d14434088507ffa390e6f5528465',
    code='1b0d28d90c86c141',
    state='900e06e2'
)

client = HelloSign::Client.new :api_key => '0ca97430f712bd3898e782000d4387c60c464155afbdb49d1fddda27c7443b98', :client_id => 'cc91c61d00f8bb2ece1428035716b', :client_secret => '1d14434088507ffa390e6f5528465'
client.get_oauth_token :state => '900e06e2', :code =>'1b0d28d90c86c141'

const hellosign = require('hellosign-sdk')({ key: '0ca97430f712bd3898e782000d4387c60c464155afbdb49d1fddda27c7443b98', clientId: 'b6b8e7deaf8f0b95c029dca049356d4a2cf9710a', clientSecret='1d14434088507ffa390e6f5528465' });

hellosign.oauth.getToken({
  state: '900e06e2',
  code: '1b0d28d90c86c141'
}).then((res) => {
  // handle response
}).catch((err) => {
  // handle error
});

Coming soon

$client = new HelloSign\Client('0ca97430f712bd3898e782000d4387c60c464155afbdb49d1fddda27c7443b98');
$client_id = 'YOUR_CLIENT_ID';
$client_secret = 'YOUR_CLIENT_SECRET';
$account = $client->createAccount(
    new HelloSign\Account(
        'jill@example.com'
    ),
    $client_id,
    $client_secret
);

HelloSignClient client = new HelloSignClient("0ca97430f712bd3898e782000d4387c60c464155afbdb49d1fddda27c7443b98");
String clientId = "cc91c61d00f8bb2ece1428035716b";
String clientSecret = "1d14434088507ffa390e6f5528465";
Account newAccount = client.createAccount("jill@example.com", clientId, clientSecret)

client = HSClient(api_key='0ca97430f712bd3898e782000d4387c60c464155afbdb49d1fddda27c7443b98')
client.create_account(
    email_address='jill@example.com',
    client_id='cc91c61d00f8bb2ece1428035716b',
    client_secret='1d14434088507ffa390e6f5528465'
)

client = HelloSign::Client.new :api_key => '0ca97430f712bd3898e782000d4387c60c464155afbdb49d1fddda27c7443b98', :client_id => 'cc91c61d00f8bb2ece1428035716b', :client_secret => '1d14434088507ffa390e6f5528465'
client.oauth_create_account :email_address => 'jill@example.com'

const hellosign = require('hellosign-sdk')({ key: '0ca97430f712bd3898e782000d4387c60c464155afbdb49d1fddda27c7443b98', clientId: 'b6b8e7deaf8f0b95c029dca049356d4a2cf9710a', clientSecret='1d14434088507ffa390e6f5528465' });

hellosign.account.create({
  email_address: 'alice@example.com'
}).then((res) => {
  // handle response
}).catch((err) => {
  // handle error
});

Coming soon

$token = new HelloSign\OAuthToken(array(
    'access_token' => 'NWNiOTMxOGFkOGVjMDhhNTAxZN2NkNjgxMjMwOWJiYTEzZTBmZGUzMjMThhMzYyMzc'
));
$client = new HelloSign\Client($token);
$signature_requests = $client->getSignatureRequests(1);

HelloSignClient client = new HelloSignClient("SIGN_IN_AND_CREATE_API_KEY_FIRST");
String code = "1b0d28d90c86c141";
String clientId = "cc91c61d00f8bb2ece1428035716b";
String clientSecret = "1d14434088507ffa390e6f5528465";
client.getOauthData(code, clientId, clientSecret);

// Subsequent requests are made using the OAuth data retrieved above
SignatureRequestList list = client.getSignatureRequests();

client = HSClient(access_token='NWNiOTMxOGFkOGVjMDhhNTAxZN2NkNjgxMjMwOWJiYTEzZTBmZGUzMjMTyMzc=')
client.get_signature_request_list()

oauth_client = HelloSign::Client.new :auth_token => 'NWNiOTMxOGFkOGVjMDhhNTAxZN2NkNjgxMjMwOWJiYTEzZTBmZGUzMjMThhMzYyMzc='
oauth_client.get_signature_requests

const hellosign = require('hellosign-sdk')({ oauthToken: 'NWNiOTMxOGFkOGVjMDhhNTAxZN2NkNjgxMjMwOWJiYTEzZTBmZGUzMjMThhMzYyMzc=' });

hellosign.signatureRequest.list().then((res) => {
  // handle response
}).catch((err) => {
  // handle error
});

var client = new Client();
client.UseOAuth2Authentication("NWNiOTMxOGFkOGVjMDhhNTAxZN2NkNjgxMjMwOWJiYTEzZTBmZGUzMjMThhMzYyMzc=");
var requests = client.ListSignatureRequests(1);

$token = new HelloSign\OAuthToken(array(
    'access_token' => 'NWNiOTMxOGFkOGVjMDhhNTAxZN2NkNjgxMjMwOWJiYTEzZTBmZGUzMjMThhMzYyMzc'
));
$client = new HelloSign\Client($token);
$request = new HelloSign\SignatureRequest;
$request->enableTestMode();
$request->setTitle('NDA with Acme Co.');
$request->setSubject('The NDA we talked about');
$request->setMessage('Please sign this NDA and then we can discuss more. Let me know if you have any
questions.');
$request->addSigner('jack@example.com', 'Jack', 0);
$request->addSigner(new HelloSign\Signer(array(
    'name' => 'Jill',
    'email_address' => 'jill@example.com',
    'order' => 1
)));
$request->addFile($path_to_nda_pdf);
$request->addFile($path_to_appendix_a_pdf);
$request->addCC('lawyer1@example.com');
$request->addCC('lawyer2@example.com');
$response = $client->sendSignatureRequest($request);

HelloSignClient client = new HelloSignClient("SIGN_IN_AND_CREATE_API_KEY_FIRST");
String code = "1b0d28d90c86c141";
String clientId = "cc91c61d00f8bb2ece1428035716b";
String clientSecret = "1d14434088507ffa390e6f5528465";
client.getOauthData(code, clientId, clientSecret);

// Subsequent requests are made using the OAuth data retrieved above

SignatureRequest request = new SignatureRequest();
request.setTitle("NDA with Acme Co.");
request.setSubject("The NDA we talked about");
request.setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.");
request.addSigner("jack@example.com", "Jack");
request.addSigner("jill@example.com", "Jill");
request.addCC("lawyer@hellosign.com");
request.addCC("lawyer@example.com");
request.addFile(new File("nda.pdf"));
request.addFile(new File("AppendixA.pdf"));
request.setTestMode(true);

SignatureRequest newRequest = client.sendSignatureRequest(request);

client = HSClient(access_token='NWNiOTMxOGFkOGVjMDhhNTAxZN2NkNjgxMjMwOWJiYTEzZTBmZGUzMjMTyMzc=')
client.send_signature_request(
    test_mode=True,
    title='NDA with Acme Co.',
    subject='The NDA we talked about',
    message='Please sign this NDA and then we can discuss more. Let me know if you have any questions.',
    signers=[
        { 'email_address': 'jack@example.com', 'name': 'Jack', 'order': 0 },
        { 'email_address': 'jill@example.com', 'name': 'Jill', 'order': 1 }
    ],
    cc_email_addresses=['lawyer@example.com', 'lawyer2@example.com'],
    files=['NDA.pdf', 'AppendixA.pdf']
)

oauth_client = HelloSign::Client.new :auth_token => 'NWNiOTMxOGFkOGVjMDhhNTAxZN2NkNjgxMjMwOWJiYTEzZTBmZGUzMjMThhMzYyMzc='
oauth_client.send_signature_request(
    :test_mode => 1,
    :title => 'NDA with Acme Co.',
    :subject => 'The NDA we talked about',
    :message => 'Please sign this NDA and then we can discuss more. Let me know if you have any
    questions.',
    :signers => [
        {
            :email_address => 'jack@example.com',
            :name => 'Jack',
            :order => 0,
        },
        {
            :email_address => 'jill@example.com',
            :name => 'Jill',
            :order => 1,
        }
    ],
    :cc_email_addresses => ['lawyer@example.com', 'lawyer2@example.com'],
    :files => ['NDA.pdf', 'AppendixA.pdf']
)

const hellosign = require('hellosign-sdk')({ oauthToken: 'NWNiOTMxOGFkOGVjMDhhNTAxZN2NkNjgxMjMwOWJiYTEzZTBmZGUzMjMThhMzYyMzc=' });

const opts = {
  test_mode: 1,
  title: 'NDA with Acme Co.',
  subject: 'The NDA we talked about',
  message: 'Please sign this NDA and then we can discuss more. Let me know if you have any questions.',
  signers: [
    {
      email_address: 'alice@example.com',
      name: 'Alice',
      order: 0
    },
    {
      email_address: 'bob@example.com',
      name: 'Bob',
      order: 1
    }
  ],
  cc_email_addresses: ['lawyer@example.com'],
  files: ['NDA.pdf]
};

hellosign.signatureRequest.send(opts).then((res) => {
  // handle response
}).catch((err) => {
  // handle error
});

var client = new Client();
client.UseOAuth2Authentication("NWNiOTMxOGFkOGVjMDhhNTAxZN2NkNjgxMjMwOWJiYTEzZTBmZGUzMjMThhMzYyMzc=");
var request = new SignatureRequest();
request.Title = "NDA with Acme Co.";
request.Subject = "The NDA we talked about";
request.Message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions.";
request.AddSigner("jack@example.com", "Jack", 0);
request.AddSigner("jill@example.com", "Jill", 1);
request.AddCc("lawyer@example.com");
request.AddCc("lawyer2@example.com");
request.AddFile("C:\Users\Me\My Documents\NDA.pdf");
request.AddFile("C:\Users\Me\My Documents\AppendixA.pdf");
request.TestMode = true;
var response = client.SendSignatureRequest(request);

$token = new HelloSign\OAuthToken(array(
    'access_token' => 'hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3'
));
$client = new HelloSign\Client($token);
$token = $client->refreshOAuthToken($token);

HelloSignClient client = new HelloSignClient("SIGN_IN_AND_CREATE_API_KEY_FIRST");
OauthData newOauthData = client.refreshOauthData(oauth.getRefreshToken());

client = HSClient(api_key='SIGN_IN_AND_CREATE_API_KEY_FIRST')
client.refresh_access_token('hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3')

client = HelloSign::Client.new :api_key => 'SIGN_IN_AND_CREATE_API_KEY_FIRST'
client.refresh_oauth_token :refresh_token => 'hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3'

const hellosign = require('hellosign-sdk')({ key: 'SIGN_IN_AND_CREATE_API_KEY_FIRST' });

hellosign.oauth.refreshToken({
  refresh_token: 'hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3'
}).then((res) => {
  // handle response
}).catch((err) => {
  // handle error
});

Coming soon