Chilkat Online Tools

C++ / Postman API / Single Mock

Back to Collection Items

#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http;
    bool success;

    http.SetRequestHeader("X-API-Key","{{postman_api_key}}");

    CkStringBuilder sbResponseBody;
    success = http.QuickGetSb("https://api.getpostman.com/mocks/{{mock_uid}}",sbResponseBody);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = http.get_LastStatus();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << http.lastHeader() << "\r\n";
        std::cout << "Failed." << "\r\n";
        return;
    }

    // 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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const char *Id = jResp.stringOf("mock.id");
    const char *Owner = jResp.stringOf("mock.owner");
    const char *Uid = jResp.stringOf("mock.uid");
    const char *Collection = jResp.stringOf("mock.collection");
    const char *Environment = jResp.stringOf("mock.environment");
    const char *MockUrl = jResp.stringOf("mock.mockUrl");
    const char *Name = jResp.stringOf("mock.name");
    bool MatchBody = jResp.BoolOf("mock.config.matchBody");
    bool MatchQueryParams = jResp.BoolOf("mock.config.matchQueryParams");
    bool MatchWildcards = jResp.BoolOf("mock.config.matchWildcards");
    const char *Delay = jResp.stringOf("mock.config.delay");
    const char *CreatedAt = jResp.stringOf("mock.createdAt");
    const char *UpdatedAt = jResp.stringOf("mock.updatedAt");
    bool IsPublic = jResp.BoolOf("mock.isPublic");
    int i = 0;
    int count_i = jResp.SizeOfArray("mock.config.headers");
    while (i < count_i) {
        jResp.put_I(i);
        i = i + 1;
    }
    }

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}"
    }
  ]
}