(Perl) Docusign: Return Brand Data Associated with a User

Demonstrates a call using an OAuth2 access token in combination with the account ID for which we have authorization.

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

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

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

$http = chilkat::CkHttp->new();

# Implements the following CURL command:

# curl --request GET https://account-d.docusign.com/restapi/v2/accounts/18b4799a-xxxx-xxxx-xxxx-b5b4b8a97604/brands --header "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ"

# Use the following online tool to generate HTTP code from a CURL command
# Convert a cURL Command to HTTP Source Code

# Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
$jsonToken = chilkat::CkJsonObject->new();
# Load a previously obtained OAuth2 access token.
$success = $jsonToken->LoadFile("qa_data/tokens/docusign.json");
if ($success == 0) {
    print $jsonToken->lastErrorText() . "\r\n";
    exit;
}

$http->put_AuthToken($jsonToken->stringOf("access_token"));

# Use an account ID obtained from DocuSign Get User Account Data
$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $http->QuickGetSb("https://account-d.docusign.com/restapi/v2/accounts/18b4799a-xxxx-xxxx-xxxx-b5b4b8a97604/brands",$sbResponseBody);
if ($success == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$json = chilkat::CkJsonObject->new();
$json->LoadSb($sbResponseBody);
$json->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $json->emit() . "\r\n";

$respStatusCode = $http->get_LastStatus();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $http->lastHeader() . "\r\n";
    print "Failed." . "\r\n";
    exit;
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "recipientBrandIdDefault": "sample string 1",
#   "senderBrandIdDefault": "sample string 2",
#   "brands": [
#     {
#       "brandCompany": "sample string 1",
#       "brandId": "sample string 2",
#       "brandName": "sample string 3",
#       "colors": [
#         {}
#       ],
#       "errorDetails": {
#         "errorCode": "sample string 1",
#         "message": "sample string 2"
#       },
#       "isOverridingCompanyName": "sample string 4",
#       "isSendingDefault": "sample string 5",
#       "isSigningDefault": "sample string 6",
#       "landingPages": [
#         {}
#       ],
#       "links": [
#         {
#           "linkType": "sample string 1",
#           "urlOrMailTo": "sample string 2",
#           "linkText": "sample string 3",
#           "showLink": "sample string 4"
#         }
#       ],
#       "emailContent": [
#         {
#           "emailContentType": "sample string 1",
#           "content": "sample string 2",
#           "emailToLink": "sample string 3",
#           "linkText": "sample string 4"
#         }
#       ],
#       "logos": {
#         "primary": "sample string 1",
#         "secondary": "sample string 2",
#         "email": "sample string 3"
#       },
#       "resources": {
#         "email": "sample string 1",
#         "sending": "sample string 2",
#         "signing": "sample string 3",
#         "signingCaptive": "sample string 4"
#       }
#     }
#   ]
# }

# Sample code for parsing the JSON response...
# Use the following online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

$recipientBrandIdDefault = $json->stringOf("recipientBrandIdDefault");
$senderBrandIdDefault = $json->stringOf("senderBrandIdDefault");
$i = 0;
$count_i = $json->SizeOfArray("brands");
while ($i < $count_i) {
    $json->put_I($i);
    $brandCompany = $json->stringOf("brands[i].brandCompany");
    $brandId = $json->stringOf("brands[i].brandId");
    $brandName = $json->stringOf("brands[i].brandName");
    $errorDetailsErrorCode = $json->stringOf("brands[i].errorDetails.errorCode");
    $errorDetailsMessage = $json->stringOf("brands[i].errorDetails.message");
    $isOverridingCompanyName = $json->stringOf("brands[i].isOverridingCompanyName");
    $isSendingDefault = $json->stringOf("brands[i].isSendingDefault");
    $isSigningDefault = $json->stringOf("brands[i].isSigningDefault");
    $logosPrimary = $json->stringOf("brands[i].logos.primary");
    $logosSecondary = $json->stringOf("brands[i].logos.secondary");
    $logosEmail = $json->stringOf("brands[i].logos.email");
    $resourcesEmail = $json->stringOf("brands[i].resources.email");
    $resourcesSending = $json->stringOf("brands[i].resources.sending");
    $resourcesSigning = $json->stringOf("brands[i].resources.signing");
    $resourcesSigningCaptive = $json->stringOf("brands[i].resources.signingCaptive");
    $j = 0;
    $count_j = $json->SizeOfArray("brands[i].colors");
    while ($j < $count_j) {
        $json->put_J($j);
        $j = $j + 1;
    }

    $j = 0;
    $count_j = $json->SizeOfArray("brands[i].landingPages");
    while ($j < $count_j) {
        $json->put_J($j);
        $j = $j + 1;
    }

    $j = 0;
    $count_j = $json->SizeOfArray("brands[i].links");
    while ($j < $count_j) {
        $json->put_J($j);
        $linkType = $json->stringOf("brands[i].links[j].linkType");
        $urlOrMailTo = $json->stringOf("brands[i].links[j].urlOrMailTo");
        $linkText = $json->stringOf("brands[i].links[j].linkText");
        $showLink = $json->stringOf("brands[i].links[j].showLink");
        $j = $j + 1;
    }

    $j = 0;
    $count_j = $json->SizeOfArray("brands[i].emailContent");
    while ($j < $count_j) {
        $json->put_J($j);
        $emailContentType = $json->stringOf("brands[i].emailContent[j].emailContentType");
        $content = $json->stringOf("brands[i].emailContent[j].content");
        $emailToLink = $json->stringOf("brands[i].emailContent[j].emailToLink");
        $linkText = $json->stringOf("brands[i].emailContent[j].linkText");
        $j = $j + 1;
    }

    $i = $i + 1;
}