PureBasic / Postman API / API Key Owner
Back to Collection Items
IncludeFile "CkJsonObject.pb"
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
CkHttp::ckSetRequestHeader(http,"X-API-Key","{{postman_api_key}}")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api.getpostman.com/me",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
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 = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "user": {
; "id": "631643",
; "username": "janedoe",
; "email": "janedoe@example.com",
; "fullName": "Jane Doe",
; "avatar": "https://www.gravatar.com/avatar/e1f3994f2632af3d1c8c2dcc168a10e6",
; "isPublic": false
; },
; "operations": [
; {
; "name": "mock_usage",
; "limit": 1000000,
; "usage": 2382,
; "overage": 0
; },
; {
; "name": "monitor_request_runs",
; "limit": 10000000,
; "usage": 49492,
; "overage": 0
; },
; {
; "name": "documenter_public_views",
; "limit": 5000000,
; "usage": 120232,
; "overage": 0
; },
; {
; "name": "api_usage",
; "limit": 1000000,
; "usage": 1345,
; "overage": 0
; },
; {
; "name": "custom_domains",
; "limit": 25,
; "usage": 1,
; "overage": 0
; },
; {
; "name": "custom_authentication_methods",
; "limit": 1,
; "usage": 1,
; "overage": 0
; },
; {
; "name": "serverless_requests",
; "limit": 10000,
; "usage": 0,
; "overage": 0
; },
; {
; "name": "integrations",
; "limit": 5000,
; "usage": 145,
; "overage": 0
; },
; {
; "name": "cloud_agent_requests",
; "limit": 1000000,
; "usage": 23823,
; "overage": 0
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
name.s
limit.i
usage.i
overage.i
Id.s = CkJsonObject::ckStringOf(jResp,"user.id")
Username.s = CkJsonObject::ckStringOf(jResp,"user.username")
v_Email.s = CkJsonObject::ckStringOf(jResp,"user.email")
FullName.s = CkJsonObject::ckStringOf(jResp,"user.fullName")
Avatar.s = CkJsonObject::ckStringOf(jResp,"user.avatar")
IsPublic.i = CkJsonObject::ckBoolOf(jResp,"user.isPublic")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"operations")
While i < count_i
CkJsonObject::setCkI(jResp, i)
name = CkJsonObject::ckStringOf(jResp,"operations[i].name")
limit = CkJsonObject::ckIntOf(jResp,"operations[i].limit")
usage = CkJsonObject::ckIntOf(jResp,"operations[i].usage")
overage = CkJsonObject::ckIntOf(jResp,"operations[i].overage")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "X-API-Key: {{postman_api_key}}"
https://api.getpostman.com/me
Postman Collection Item JSON
{
"name": "API Key Owner",
"event": [
{
"listen": "test",
"script": {
"type": "text/javascript",
"exec": [
"var responseJSON;",
"",
"// parse response body as JSON",
"try { responseJSON = JSON.parse(responseBody); } catch (e) { }",
"tests['received a valid response JSON'] = !!responseJSON;",
"!responseJSON && (responseJSON = {});",
"",
"tests['status code is 200'] = (responseCode.code === 200);",
"tests['response does not have errors'] = (!responseJSON.error);",
"",
"tests['response has a user object'] = (typeof responseJSON.user === 'object');",
"tests['response user object has id'] = (responseJSON.user && responseJSON.user.id);"
]
}
}
],
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/me",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"me"
]
},
"description": "the `/me` Postman API endpoint lets you access information about the authenticated user. You can retrieve the authenticated user's username, full name, e-mail address, and any other available information.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
},
"response": [
{
"name": "Valid Response",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/me",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"me"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"name": "Content-Type",
"description": {
"content": "",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"user\": {\n \"id\": \"631643\",\n \"username\": \"janedoe\",\n \"email\": \"janedoe@example.com\",\n \"fullName\": \"Jane Doe\",\n \"avatar\": \"https://www.gravatar.com/avatar/e1f3994f2632af3d1c8c2dcc168a10e6\",\n \"isPublic\": false\n },\n \"operations\": [\n {\n \"name\": \"mock_usage\",\n \"limit\": 1000000,\n \"usage\": 2382,\n \"overage\": 0\n },\n {\n \"name\": \"monitor_request_runs\",\n \"limit\": 10000000,\n \"usage\": 49492,\n \"overage\": 0\n },\n {\n \"name\": \"documenter_public_views\",\n \"limit\": 5000000,\n \"usage\": 120232,\n \"overage\": 0\n },\n {\n \"name\": \"api_usage\",\n \"limit\": 1000000,\n \"usage\": 1345,\n \"overage\": 0\n },\n {\n \"name\": \"custom_domains\",\n \"limit\": 25,\n \"usage\": 1,\n \"overage\": 0\n },\n {\n \"name\": \"custom_authentication_methods\",\n \"limit\": 1,\n \"usage\": 1,\n \"overage\": 0\n },\n {\n \"name\": \"serverless_requests\",\n \"limit\": 10000,\n \"usage\": 0,\n \"overage\": 0\n },\n {\n \"name\": \"integrations\",\n \"limit\": 5000,\n \"usage\": 145,\n \"overage\": 0\n },\n {\n \"name\": \"cloud_agent_requests\",\n \"limit\": 1000000,\n \"usage\": 23823,\n \"overage\": 0\n }\n ]\n}"
}
]
}
