Chilkat Online Tools

phpAx / Squadcast API V3 / Access 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->SetRequestHeader('X-Refresh-Token','<string>');

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$success = $http->QuickGetSb('https://auth.squadcast.com/oauth/access-token',$sbResponseBody);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// 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 = $http->LastStatus;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->LastHeader . "\n";
    print 'Failed.' . "\n";
    exit;
}

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

// {
//   "data": {
//     "access_token": "eyJhbGciOiXXXXXXXXXXXXXX.eyJleHXXXXXXXXX.XXXXXXXXXXOwuvUNA",
//     "expires_at": 1587412870,
//     "issued_at": 1587240070,
//     "refresh_token": "0d2a1a9a45XXXXXXXXXXXXXX3f134279",
//     "type": "Bearer"
//   }
// }

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

$Access_token = $jResp->stringOf('data.access_token');
$Expires_at = $jResp->IntOf('data.expires_at');
$Issued_at = $jResp->IntOf('data.issued_at');
$Refresh_token = $jResp->stringOf('data.refresh_token');
$v_Type = $jResp->stringOf('data.type');

?>

Curl Command

curl -X GET
	-H "X-Refresh-Token: <string>"
https://auth.squadcast.com/oauth/access-token

Postman Collection Item JSON

{
  "name": "Access Token",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "postman.clearGlobalVariable(\"access_token\");",
          "",
          "var jsonData = JSON.parse(responseBody);",
          "console.log(jsonData);",
          "",
          "",
          "if(responseCode.code === 200){",
          "   postman.setEnvironmentVariable(\"access_token\", jsonData.data.access_token);",
          "   postman.setGlobalVariable(\"access_token\", jsonData.data.access_token);",
          "   tests[\"Successful Login\"] = true;",
          "}else if(responseCode.code === 400){",
          "  tests[\"Invalid Credentials\"] =  false;",
          "}else{",
          "    tests[\"Failed Login\"] = true;",
          "}",
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "GET",
    "header": [
      {
        "description": "(Required) Send your refresh token optained from Squadcast web application.",
        "key": "X-Refresh-Token",
        "value": "<string>"
      }
    ],
    "url": {
      "raw": "https://auth.squadcast.com/oauth/access-token",
      "protocol": "https",
      "host": [
        "auth",
        "squadcast",
        "com"
      ],
      "path": [
        "oauth",
        "access-token"
      ]
    },
    "description": "Get access token to make authenticated HTTP requests to the Squadcast API."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "X-Refresh-Token",
            "value": "<string>",
            "description": "(Required) Send your refresh token optained from Squadcast web application."
          }
        ],
        "url": {
          "raw": "https://auth.squadcast.com/oauth/access-token",
          "protocol": "https",
          "host": [
            "auth",
            "squadcast",
            "com"
          ],
          "path": [
            "oauth",
            "access-token"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"data\": {\n  \"access_token\": \"eyJhbGciOiXXXXXXXXXXXXXX.eyJleHXXXXXXXXX.XXXXXXXXXXOwuvUNA\",\n  \"expires_at\": 1587412870,\n  \"issued_at\": 1587240070,\n  \"refresh_token\": \"0d2a1a9a45XXXXXXXXXXXXXX3f134279\",\n  \"type\": \"Bearer\"\n }\n}"
    },
    {
      "name": "Internal Server Error",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "X-Refresh-Token",
            "value": "<string>",
            "description": "(Required) Send your refresh token optained from Squadcast web application."
          }
        ],
        "url": {
          "raw": "https://auth.squadcast.com/oauth/access-token",
          "protocol": "https",
          "host": [
            "auth",
            "squadcast",
            "com"
          ],
          "path": [
            "oauth",
            "access-token"
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": 500,\n  \"error_message\": \"soemthing went wrong\"\n }\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "X-Refresh-Token",
            "value": "<string>",
            "description": "(Required) Send your refresh token optained from Squadcast web application."
          }
        ],
        "url": {
          "raw": "https://auth.squadcast.com/oauth/access-token",
          "protocol": "https",
          "host": [
            "auth",
            "squadcast",
            "com"
          ],
          "path": [
            "oauth",
            "access-token"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": 400,\n  \"error_message\": \"invalid refresh token\"\n }\n}"
    }
  ]
}