Chilkat Online Tools

phpAx / Broker API / Authorize an OAuth Token

Back to Collection Items

<?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");

$http->BasicAuth = 1;
$http->Login = '{{api_key}}';
$http->Password = '{{api_secret}}';

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

// The following JSON is sent in the request body.

// {
//   "client_id": "7a3c52a910e1dc2abbb14da2b6b8e711",
//   "client_secret": "{client_secret}",
//   "redirect_uri": "www.example.com/oauth_redirect",
//   "scope": "general",
//   "account_id": "{account_id}"
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('client_id','7a3c52a910e1dc2abbb14da2b6b8e711');
$json->UpdateString('client_secret','{client_secret}');
$json->UpdateString('redirect_uri','www.example.com/oauth_redirect');
$json->UpdateString('scope','general');
$json->UpdateString('account_id','{account_id}');

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://domain.com/v1/oauth/authorize','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

Curl Command

curl -X POST
	-u '{{api_key}}:{{api_secret}}'
	-d '{
  "client_id": "7a3c52a910e1dc2abbb14da2b6b8e711",
  "client_secret": "{client_secret}",
  "redirect_uri": "www.example.com/oauth_redirect",
  "scope": "general",
  "account_id": "{account_id}"
}'
https://domain.com/v1/oauth/authorize

Postman Collection Item JSON

{
  "name": "Authorize an OAuth Token",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"client_id\": \"7a3c52a910e1dc2abbb14da2b6b8e711\",\n  \"client_secret\": \"{client_secret}\",\n  \"redirect_uri\": \"www.example.com/oauth_redirect\",\n  \"scope\": \"general\",\n  \"account_id\": \"{account_id}\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HOST}}/v1/oauth/authorize",
      "host": [
        "{{HOST}}"
      ],
      "path": [
        "v1",
        "oauth",
        "authorize"
      ]
    },
    "description": "| Attribute         | Type           | Requirement                           | Notes                          |\n| ----------------- | -------------- | ------------------------------------- | ------------------------------ |\n| `client_id`       | string         | Required | OAuth `client_id`               |\n| `client_secret`   | string         | Required | OAuth `client_secret`            |\n| `redirect_uri`    | string         | Required | Redirect URI of OAuth flow     |\n| `scope`          | string/numeric | Required | Requested scopes by OAuth flow |\n| `account_id`      | string         | Required | UUID of end user               |"
  },
  "response": [
  ]
}