(PHP Extension) Docusign Refresh OAuth2 Access Token

See more DocuSign Examples

Demonstrates how to refresh a Docusign OAuth2 access token. The refresh does not require user interaction via a web browser. If an access token expires (typically with a 401 response code), a new access token can be automatically obtained by using the code in this example.

For more information, see https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

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

// It is assumed we previously obtained an OAuth2 access token.
// This example loads the JSON access token file 
// saved by this example: Get Docusign OAuth2 Access Token

$jsonToken = new CkJsonObject();
$success = $jsonToken->LoadFile('qa_data/tokens/docusign.json');
if ($success != true) {
    print 'Failed to load docusign.json' . "\n";
    exit;
}

// The access token JSON looks like this:

// {
//   "access_token": "eyJ0eXA....YQyig",
//   "token_type": "Bearer",
//   "refresh_token": "eyJ0eXA....auE3eHKg",
//   "expires_in": 28800
// }

$oauth2 = new CkOAuth2();

// For the developer sandbox environment, the token endpoint is https://account-d.docusign.com/oauth/token
// For the production platform, the token endpoint is https://account.docusign.com/oauth/token
$oauth2->put_TokenEndpoint('https://account-d.docusign.com/oauth/token');

// Replace these with actual values.
// The client ID is also known as the "integration key" in Docusign.
$oauth2->put_ClientId('MY_DOCUSIGN_CLIENT_ID');
// This is your secret key for the authorization code grant.
$oauth2->put_ClientSecret('MY_DOCUSIGN_CLIENT_SECRET');

// Get the "refresh_token"
$oauth2->put_RefreshToken($jsonToken->stringOf('refresh_token'));

// Send the HTTP POST to refresh the access token..
$success = $oauth2->RefreshAccessToken();
if ($success != true) {
    print $oauth2->lastErrorText() . "\n";
    exit;
}

print 'New access token: ' . $oauth2->accessToken() . "\n";
print 'New refresh token: ' . $oauth2->refreshToken() . "\n";

// Update the JSON with the new tokens.
$jsonToken->UpdateString('access_token',$oauth2->accessToken());
$jsonToken->UpdateString('refresh_token',$oauth2->refreshToken());

// Save the new JSON access token response to a file.
$sbJson = new CkStringBuilder();
$jsonToken->put_EmitCompact(false);
$jsonToken->EmitSb($sbJson);
$sbJson->WriteFile('qa_data/tokens/docusign.json','utf-8',false);

print 'OAuth2 authorization granted!' . "\n";
print 'New Access Token = ' . $oauth2->accessToken() . "\n";

?>