Chilkat Online Tools

PureBasic / Postman API / Single Mock

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/mocks/{{mock_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)

    ; {
    ;   "mock": {
    ;     "id": "950dcaf2-ec37-4365-b106-ed659cc2ff5d",
    ;     "owner": "1679925",
    ;     "uid": "1679925-950dcaf2-ec37-4365-b106-ed659cc2ff5d",
    ;     "collection": "1679925-8aa4c661-e0f4-4db0-98bc-d52cb72b5cbf",
    ;     "environment": "1679925-2b90cdd8-e9ac-4086-91c2-bc4cad659511",
    ;     "mockUrl": "https://950dcaf2-ec37-4365-b106-ed659cc2ff5d.mock.pstmn.io",
    ;     "name": "mock1",
    ;     "config": {
    ;       "headers": [
    ;       ],
    ;       "matchBody": false,
    ;       "matchQueryParams": true,
    ;       "matchWildcards": true,
    ;       "delay": null
    ;     },
    ;     "createdAt": "2020-12-14T08:12:21.000Z",
    ;     "updatedAt": "2020-12-15T06:44:37.000Z",
    ;     "isPublic": false
    ;   }
    ; }

    ; Sample code for parsing the JSON response...
    ; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    Id.s = CkJsonObject::ckStringOf(jResp,"mock.id")
    Owner.s = CkJsonObject::ckStringOf(jResp,"mock.owner")
    Uid.s = CkJsonObject::ckStringOf(jResp,"mock.uid")
    Collection.s = CkJsonObject::ckStringOf(jResp,"mock.collection")
    Environment.s = CkJsonObject::ckStringOf(jResp,"mock.environment")
    MockUrl.s = CkJsonObject::ckStringOf(jResp,"mock.mockUrl")
    Name.s = CkJsonObject::ckStringOf(jResp,"mock.name")
    MatchBody.i = CkJsonObject::ckBoolOf(jResp,"mock.config.matchBody")
    MatchQueryParams.i = CkJsonObject::ckBoolOf(jResp,"mock.config.matchQueryParams")
    MatchWildcards.i = CkJsonObject::ckBoolOf(jResp,"mock.config.matchWildcards")
    Delay.s = CkJsonObject::ckStringOf(jResp,"mock.config.delay")
    CreatedAt.s = CkJsonObject::ckStringOf(jResp,"mock.createdAt")
    UpdatedAt.s = CkJsonObject::ckStringOf(jResp,"mock.updatedAt")
    IsPublic.i = CkJsonObject::ckBoolOf(jResp,"mock.isPublic")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"mock.config.headers")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        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/mocks/{{mock_uid}}

Postman Collection Item JSON

{
  "name": "Single Mock",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.getpostman.com/mocks/{{mock_uid}}",
      "protocol": "https",
      "host": [
        "api",
        "getpostman",
        "com"
      ],
      "path": [
        "mocks",
        "{{mock_uid}}"
      ]
    },
    "description": "This endpoint fetches you the basic information about a single mock using its `uid`.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
  },
  "response": [
    {
      "name": "Successful Response",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.getpostman.com/mocks/{{mock_uid}}",
          "protocol": "https",
          "host": [
            "api",
            "getpostman",
            "com"
          ],
          "path": [
            "mocks",
            "{{mock_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    \"mock\":{\n        \"id\":\"950dcaf2-ec37-4365-b106-ed659cc2ff5d\",\n        \"owner\":\"1679925\",\n        \"uid\":\"1679925-950dcaf2-ec37-4365-b106-ed659cc2ff5d\",\n        \"collection\":\"1679925-8aa4c661-e0f4-4db0-98bc-d52cb72b5cbf\",\n        \"environment\": \"1679925-2b90cdd8-e9ac-4086-91c2-bc4cad659511\",\n        \"mockUrl\":\"https://950dcaf2-ec37-4365-b106-ed659cc2ff5d.mock.pstmn.io\",\n        \"name\":\"mock1\",\n        \"config\":{\n            \"headers\":[],\n            \"matchBody\":false,\n            \"matchQueryParams\":true,\n            \"matchWildcards\":true,\n            \"delay\":null\n        },\n        \"createdAt\":\"2020-12-14T08:12:21.000Z\",\n        \"updatedAt\":\"2020-12-15T06:44:37.000Z\",\n        \"isPublic\":false\n    }\n}"
    }
  ]
}