PHP

Refinitiv World-Check One - Get Top Level Groups

See more Refinitiv Examples

Sends a signed GET request to get the top level groups.

Note: This example requires Chilkat v9.5.0.89 or later.

Chilkat2 PHP

<?php

use Chilkat2\Http;
use Chilkat2\JsonArray;
use Chilkat2\JsonObject;

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

$json = new JsonObject();

// Create the following JSON:
//
// {
//   "keyId": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
//   "hmacKey": "xxxxzI3vi58xxxCBxxx1+P/d8tGxx7KuLqN/KMPNxxxxekhj8/bx83+1YQSUxxxxYyv939ceY06GvhYRKmxxxx==",
//   "algorithm": "hmac-sha256",
//   "headers": [
//     "(request-target)",
//     "host",
//     "date"
//   ]
// }

// Substitute your actual API key and API secret in place of "api-key" and "api-secret"
$json->UpdateString('keyId', 'api-key');
$json->UpdateString('hmacKey', 'api-secret');
$json->UpdateString('algorithm', 'hmac-sha256');
// Indicate the names of the headers to be included in the signature.
// "(request-target)" is not actually a header name, but is a special name for HTTP signatures.
// Copy the following three lines of code exactly as-is.
// Do not replace "host", "date", or "(request-target)" with values.
$json->UpdateString('headers[0]', '(request-target)');
$json->UpdateString('headers[1]', 'host');
$json->UpdateString('headers[2]', 'date');

$http = new Http();

// Setting the AuthSignature property causes the following header to be computed and added:
// Authorization: Signature keyId="...", algorithm="hmac-sha256", headers="(request-target) host date", signature="..."
$http->AuthSignature = $json->Emit();

$http->SetRequestHeader('Cache-Control', 'no-cache');

// Chilkat will auto-add the Date header because it's needed by the HTTP Signature.

try {
    $responseJson = $http->QuickGetStr('https://api-worldcheck.refinitiv.com/v2/groups');
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

echo $responseJson, "\n";
echo "----\n";
// A 200 status code indicates success.
echo 'Status code = ', $http->LastStatus, "\n";

// Successful JSON looks like this:
// [
//   {
//   "id": "...",
//   "name": "Company Name",
//   "parentId": null,
//   "hasChildren": false,
//   "status": "ACTIVE",
//   "children": []
//   }
// ]

// Use this online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

$jarr = new JsonArray();

$jarr->Load($responseJson);

$jsonObj = null;
$id = '';
$name = '';
$parentId = '';
$hasChildren = false;
$status = '';
$j = 0;
$count_j = 0;

$i = 0;
$count_i = $jarr->Size;
while ($i < $count_i) {
    $jsonObj = $jarr->ObjectAt($i);
    $id = $jsonObj->StringOf('id');
    $name = $jsonObj->StringOf('name');
    $parentId = $jsonObj->StringOf('parentId');
    $hasChildren = $jsonObj->BoolOf('hasChildren');
    $status = $jsonObj->StringOf('status');
    $j = 0;
    $count_j = $jsonObj->SizeOfArray('children');
    while ($j < $count_j) {
        $jsonObj->J = $j;
        $j = $j + 1;
    }

    $i = $i + 1;
}