Back to Collection Items
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.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
; Adds the "Authorization: Bearer {{token}}" header.
CkHttp::setCkAuthToken(http, "{{token}}")
CkHttp::ckSetRequestHeader(http,"X-GP-Version","2020-12-22")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://{{url}}/ucp/ping",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
Debug "Response status code = " + Str(CkHttp::ckLastStatus(http))
Debug CkStringBuilder::ckGetAsString(sbResponseBody)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "Authorization: Bearer {{token}}"
-H "X-GP-Version: 2020-12-22"
https://{{url}}/ucp/ping
Postman Collection Item JSON
{
"name": "Ping GP-API",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{token}}"
},
{
"key": "X-GP-Version",
"value": "2020-12-22"
}
],
"url": {
"raw": "https://{{url}}/ucp/ping",
"protocol": "https",
"host": [
"{{url}}"
],
"path": [
"ucp",
"ping"
]
},
"description": "This request can be sent to periodically check if the API is up"
},
"response": [
]
}