PureBasic / Postman API / Single Collection
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/collections/{{collection_uid}}",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)
; {
; "collection": {
; "variables": [
; ],
; "info": {
; "name": "Sample Collection",
; "_postman_id": "f2e66c2e-5297-e4a5-739e-20cbb90900e3",
; "description": "This is a sample collection that makes a tiny request to Postman Echo service to get the list of request headers sent by a HTTP client.",
; "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json"
; },
; "item": [
; {
; "id": "82ee981b-e19f-962a-401e-ea34ebfb4848",
; "name": "Request Headers",
; "event": [
; {
; "listen": "test",
; "script": {
; "type": "text/javascript",
; "exec": "var responseJSON;\ntry {\n tests[\"Body contains headers\"] = responseBody.has(\"headers\");\n responseJSON = JSON.parse(responseBody);\n tests[\"Header contains host\"] = \"host\" in responseJSON.headers;\n tests[\"Header contains test parameter sent as part of request header\"] = \"my-sample-header\" in responseJSON.headers;\n}\ncatch (e) { }\n\n\n\n"
; }
; }
; ],
; "request": {
; "url": "https://echo.getpostman.com/headers",
; "method": "GET",
; "header": [
; {
; "key": "my-sample-header",
; "value": "Lorem ipsum dolor sit amet",
; "description": ""
; }
; ],
; "body": {
; "mode": "formdata",
; "formdata": [
; ]
; },
; "description": ""
; },
; "response": [
; ]
; }
; ]
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
id.s
name.s
v_Url.s
Method.s
Mode.s
requestDescription.s
j.i
count_j.i
listen.s
v_Type.s
Exec.s
key.s
value.s
description.s
Name.s = CkJsonObject::ckStringOf(jResp,"collection.info.name")
v_postman_id.s = CkJsonObject::ckStringOf(jResp,"collection.info._postman_id")
Description.s = CkJsonObject::ckStringOf(jResp,"collection.info.description")
Schema.s = CkJsonObject::ckStringOf(jResp,"collection.info.schema")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"collection.variables")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"collection.item")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"collection.item[i].id")
name = CkJsonObject::ckStringOf(jResp,"collection.item[i].name")
v_Url = CkJsonObject::ckStringOf(jResp,"collection.item[i].request.url")
Method = CkJsonObject::ckStringOf(jResp,"collection.item[i].request.method")
Mode = CkJsonObject::ckStringOf(jResp,"collection.item[i].request.body.mode")
requestDescription = CkJsonObject::ckStringOf(jResp,"collection.item[i].request.description")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"collection.item[i].event")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
listen = CkJsonObject::ckStringOf(jResp,"collection.item[i].event[j].listen")
v_Type = CkJsonObject::ckStringOf(jResp,"collection.item[i].event[j].script.type")
Exec = CkJsonObject::ckStringOf(jResp,"collection.item[i].event[j].script.exec")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"collection.item[i].request.header")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
key = CkJsonObject::ckStringOf(jResp,"collection.item[i].request.header[j].key")
value = CkJsonObject::ckStringOf(jResp,"collection.item[i].request.header[j].value")
description = CkJsonObject::ckStringOf(jResp,"collection.item[i].request.header[j].description")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"collection.item[i].request.body.formdata")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"collection.item[i].response")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
j = j + 1
Wend
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/collections/{{collection_uid}}
Postman Collection Item JSON
{
"name": "Single Collection ",
"event": [
{
"listen": "test",
"script": {
"type": "text/javascript",
"exec": [
"pm.test(\"response is ok\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"pm.test(\"response json data should not have errors\", function () {",
" pm.response.to.have.jsonBody();",
" pm.response.to.not.have.jsonBody('error');",
"});",
"",
"pm.test(\"response json should contain one collection\", function () {",
" pm.expect(pm.response.json()).to.have.property('collection').and.be.an('object');",
"});",
"",
"// additional tests to ensure that the relevant environment variables are present",
"pm.test('\"postman_api_key\" variable should be present', function () {",
" pm.expect(pm.variables.get('postman_api_key')).to.be.a('string');",
"});",
"",
"// you can unskip this test in case you want to have a stricter check on the selected",
"// environment.",
"pm.test.skip('\"collection_uid\" variable should be present', function () {",
" pm.expect(pm.variables.get('collection_uid')).to.be.a('string');",
"});"
]
}
}
],
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/collections/{{collection_uid}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"collections",
"{{collection_uid}}"
]
},
"description": "Access the contents of a collection that is accessible to you using its unique id (`uid`).\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/collections/{{collection_uid}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"collections",
"{{collection_uid}}"
]
}
},
"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 \"collection\": {\n \"variables\": [],\n \"info\": {\n \"name\": \"Sample Collection\",\n \"_postman_id\": \"f2e66c2e-5297-e4a5-739e-20cbb90900e3\",\n \"description\": \"This is a sample collection that makes a tiny request to Postman Echo service to get the list of request headers sent by a HTTP client.\",\n \"schema\": \"https://schema.getpostman.com/json/collection/v2.0.0/collection.json\"\n },\n \"item\": [\n {\n \"id\": \"82ee981b-e19f-962a-401e-ea34ebfb4848\",\n \"name\": \"Request Headers\",\n \"event\": [\n {\n \"listen\": \"test\",\n \"script\": {\n \"type\": \"text/javascript\",\n \"exec\": \"var responseJSON;\\ntry {\\n tests[\\\"Body contains headers\\\"] = responseBody.has(\\\"headers\\\");\\n responseJSON = JSON.parse(responseBody);\\n tests[\\\"Header contains host\\\"] = \\\"host\\\" in responseJSON.headers;\\n tests[\\\"Header contains test parameter sent as part of request header\\\"] = \\\"my-sample-header\\\" in responseJSON.headers;\\n}\\ncatch (e) { }\\n\\n\\n\\n\"\n }\n }\n ],\n \"request\": {\n \"url\": \"https://echo.getpostman.com/headers\",\n \"method\": \"GET\",\n \"header\": [\n {\n \"key\": \"my-sample-header\",\n \"value\": \"Lorem ipsum dolor sit amet\",\n \"description\": \"\"\n }\n ],\n \"body\": {\n \"mode\": \"formdata\",\n \"formdata\": []\n },\n \"description\": \"\"\n },\n \"response\": []\n }\n ]\n }\n}"
}
]
}
