Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttpRequest.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
req.i = CkHttpRequest::ckCreate()
If req.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
jsonParam1.i = CkJsonObject::ckCreate()
If jsonParam1.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpRequest::ckAddParam(req,"client_id",CkJsonObject::ckEmit(jsonParam1))
CkHttpRequest::ckAddParam(req,"grant_type","http://oauth.net/grant_type/device/1.0")
jsonParam3.i = CkJsonObject::ckCreate()
If jsonParam3.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpRequest::ckAddParam(req,"code",CkJsonObject::ckEmit(jsonParam3))
resp.i = CkHttp::ckPostUrlEncoded(http,"https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/access_token",req)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkHttpRequest::ckDispose(req)
CkJsonObject::ckDispose(jsonParam1)
CkJsonObject::ckDispose(jsonParam3)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkHttpRequest::ckDispose(req)
CkJsonObject::ckDispose(jsonParam1)
CkJsonObject::ckDispose(jsonParam3)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "access_token": "eyJ0eXAiJ9.eyJzdWIiOiJkZPXXcM",
; "refresh_token": "eyJ0eXAiOiJKV1QiLC.eyl0VHJXpdhFiWDw",
; "token_type": "Bearer",
; "expires_in": 3599
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
access_token.s = CkJsonObject::ckStringOf(jResp,"access_token")
refresh_token.s = CkJsonObject::ckStringOf(jResp,"refresh_token")
token_type.s = CkJsonObject::ckStringOf(jResp,"token_type")
expires_in.i = CkJsonObject::ckIntOf(jResp,"expires_in")
CkHttp::ckDispose(http)
CkHttpRequest::ckDispose(req)
CkJsonObject::ckDispose(jsonParam1)
CkJsonObject::ckDispose(jsonParam3)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
--data-urlencode 'client_id={{postmanPublicClientId}}'
--data-urlencode 'grant_type=http://oauth.net/grant_type/device/1.0'
--data-urlencode 'code={{device_code}}'
https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/access_token
Postman Collection Item JSON
{
"name": "Step 4: Poll for Authorization",
"event": [
{
"listen": "test",
"script": {
"exec": [
"var jsonData = JSON.parse(responseBody);",
"",
"if(jsonData.access_token && jsonData.access_token != \"\")",
"{",
" pm.globals.set(\"access_token\", jsonData.access_token);",
"}",
"",
"if(jsonData.refresh_token && jsonData.refresh_token != \"\")",
"{",
" pm.globals.set(\"refresh_token\", jsonData.refresh_token);",
"}",
"",
"// Tests",
"",
"pm.test(\"Status code is 200\", () => {",
" pm.expect(pm.response.code).to.eql(200);",
"});",
"",
"pm.test(\"Status code is not 400 - Polling too Quickly\", () => {",
" // The polling interval has not elapsed since the last request. ",
" pm.expect(pm.response.code).to.not.eql(400);",
"});",
"",
"pm.test(\"Status code is not 401 - Token not valid\", () => {",
" // The request contains a token no longer valid. ",
" pm.expect(pm.response.code).to.not.eql(401);",
"});",
"",
"pm.test(\"Response contains access_token\", function () {",
" pm.expect(jsonData.access_token).to.be.a(\"string\");",
"});",
"",
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "client_id",
"value": "{{postmanPublicClientId}}",
"description": "The ID of the Confidential OAuth Client.",
"type": "text"
},
{
"key": "grant_type",
"value": "http://oauth.net/grant_type/device/1.0",
"description": "Grant types needed for the Device Flow grant. ",
"type": "text"
},
{
"key": "code",
"value": "{{device_code}}",
"description": "The device code for the device.",
"type": "text"
}
]
},
"url": {
"raw": "{{amUrl}}/oauth2{{realm}}/access_token",
"host": [
"{{amUrl}}"
],
"path": [
"oauth2{{realm}}",
"access_token"
]
},
"description": "Poll the authorization server for an access token, to find out whether the resource owner has already given consent or not."
},
"response": [
{
"name": "Example",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "client_id",
"value": "{{postmanPublicClientId}}",
"description": "The ID of the Confidential OAuth Client.",
"type": "text"
},
{
"key": "grant_type",
"value": "http://oauth.net/grant_type/device/1.0",
"description": "Grant types needed for the Device Flow grant. ",
"type": "text"
},
{
"key": "code",
"value": "{{device_code}}",
"description": "The device code for the device.",
"type": "text"
}
]
},
"url": {
"raw": "{{amUrl}}/oauth2{{realm}}/access_token",
"host": [
"{{amUrl}}"
],
"path": [
"oauth2{{realm}}",
"access_token"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "Cache-Control",
"value": "no-store"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Content-Length",
"value": "1618"
},
{
"key": "Date",
"value": "Thu, 13 Aug 2020 12:18:30 GMT"
}
],
"cookie": [
],
"body": "{\n \"access_token\": \"eyJ0eXAiJ9.eyJzdWIiOiJkZPXXcM\",\n \"refresh_token\": \"eyJ0eXAiOiJKV1QiLC.eyl0VHJXpdhFiWDw\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3599\n}"
}
]
}
