Chilkat Online Tools

TCL / Squadcast API V3 / Access Token

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_SetRequestHeader $http "X-Refresh-Token" "<string>"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://auth.squadcast.com/oauth/access-token" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    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

set Access_token [CkJsonObject_stringOf $jResp "data.access_token"]
set Expires_at [CkJsonObject_IntOf $jResp "data.expires_at"]
set Issued_at [CkJsonObject_IntOf $jResp "data.issued_at"]
set Refresh_token [CkJsonObject_stringOf $jResp "data.refresh_token"]
set v_Type [CkJsonObject_stringOf $jResp "data.type"]

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

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}"
    }
  ]
}