(PHP ActiveX) citi Developer OAuth2 Client Credentials Grant

Get access token for your application credentials. You can use this for citi APIs which do not require customer credential verification and consent (e.g. Onboarding).

For more information, see https://sandbox.developerhub.citi.com/api/united-states/retail-bank/identity-security/authorize/documentation

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// Implements the following CURL command:

// curl --request POST \
//   --url https://sandbox.apihub.citi.com/gcb/api/clientCredentials/oauth2/token/us/gcb \
//   --header 'accept: application/json' \
//   --user client-id:client-secret \
//   --header 'content-type: application/x-www-form-urlencoded' \
//   --data 'grant_type=client_credentials&scope=%2Fapi'

$http->Login = 'client-id';
$http->Password = 'client-secret';

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.HttpRequest')
$req = new COM("Chilkat.HttpRequest");
$req->HttpVerb = 'POST';
$req->Path = '/gcb/api/clientCredentials/oauth2/token/us/gcb';
$req->ContentType = 'application/x-www-form-urlencoded';
$req->AddParam('grant_type','client_credentials');
$req->AddParam('scope','/api');
$req->AddHeader('accept','application/json');

// resp is a Chilkat.HttpResponse
$resp = $http->PostUrlEncoded('https://sandbox.apihub.citi.com/gcb/api/clientCredentials/oauth2/token/us/gcb',$req);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->Header . "\n";
    print 'Failed.' . "\n";

    exit;
}

$success = $jResp->WriteFile('qa_data/tokens/citi_client_credentials.json');
if ($success == 0) {
    print 'Failed to save JSON access token file.' . "\n";
    exit;
}

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

//  {
//    "token_type": "bearer",
//    "access_token": "AAIkMjdh ... 3fsWb7zJ0s",
//    "expires_in": 1800,
//    "consented_on": 1584817860,
//    "scope": "/api"
//  }

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

$token_type = $jResp->stringOf('token_type');
$access_token = $jResp->stringOf('access_token');
$expires_in = $jResp->IntOf('expires_in');
$consented_on = $jResp->IntOf('consented_on');
$scope = $jResp->stringOf('scope');

?>