Chilkat Online Tools

C++ / Postman API / All Mocks

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",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)

    // {
    //   "mocks": [
    //     {
    //       "id": "e782b64e-406b-4a6c-8fe9-9ebe84aeb706",
    //       "owner": "1686168",
    //       "uid": "1686168-e782b64e-406b-4a6c-8fe9-9ebe84aeb706",
    //       "collection": "1686168-39fee52f-b806-3ffa-1173-00a6f5b183dc",
    //       "environment": "1686168-2b90cdd8-e9ac-4086-91c2-bc4cad659511",
    //       "mockUrl": "https://e782b64e-406b-4a6c-8fe9-9ebe84aeb706.mock.pstmn.io",
    //       "name": "mock1",
    //       "config": {
    //         "headers": [
    //         ],
    //         "matchBody": false,
    //         "matchQueryParams": true,
    //         "matchWildcards": true,
    //         "delay": null
    //       },
    //       "createdAt": "2020-12-15T06:44:37.000Z",
    //       "updatedAt": "2020-12-15T06:44:37.000Z",
    //       "isPublic": false
    //     },
    //     {
    //       "id": "8f9d4b95-780d-455d-af38-772277bc9393",
    //       "owner": "1686168",
    //       "uid": "1686168-8f9d4b95-780d-455d-af38-772277bc9393",
    //       "collection": "1686168-37eeb72f-5d3e-48b4-8022-6b9cca6d2664",
    //       "mockUrl": "https://8f9d4b95-780d-455d-af38-772277bc93936.mock.pstmn.io",
    //       "name": "mock2",
    //       "config": {
    //         "headers": [
    //         ],
    //         "matchBody": false,
    //         "matchQueryParams": true,
    //         "matchWildcards": true,
    //         "delay": null
    //       },
    //       "createdAt": "2020-11-15T06:44:37.000Z",
    //       "updatedAt": "2020-12-15T06:48:37.000Z",
    //       "isPublic": true
    //     }
    //   ]
    // }

    // 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 = 0;
    const char *owner = 0;
    const char *uid = 0;
    const char *collection = 0;
    const char *environment = 0;
    const char *mockUrl = 0;
    const char *name = 0;
    bool MatchBody;
    bool MatchQueryParams;
    bool MatchWildcards;
    const char *Delay = 0;
    const char *createdAt = 0;
    const char *updatedAt = 0;
    bool isPublic;
    int j;
    int count_j;

    int i = 0;
    int count_i = jResp.SizeOfArray("mocks");
    while (i < count_i) {
        jResp.put_I(i);
        id = jResp.stringOf("mocks[i].id");
        owner = jResp.stringOf("mocks[i].owner");
        uid = jResp.stringOf("mocks[i].uid");
        collection = jResp.stringOf("mocks[i].collection");
        environment = jResp.stringOf("mocks[i].environment");
        mockUrl = jResp.stringOf("mocks[i].mockUrl");
        name = jResp.stringOf("mocks[i].name");
        MatchBody = jResp.BoolOf("mocks[i].config.matchBody");
        MatchQueryParams = jResp.BoolOf("mocks[i].config.matchQueryParams");
        MatchWildcards = jResp.BoolOf("mocks[i].config.matchWildcards");
        Delay = jResp.stringOf("mocks[i].config.delay");
        createdAt = jResp.stringOf("mocks[i].createdAt");
        updatedAt = jResp.stringOf("mocks[i].updatedAt");
        isPublic = jResp.BoolOf("mocks[i].isPublic");
        j = 0;
        count_j = jResp.SizeOfArray("mocks[i].config.headers");
        while (j < count_j) {
            jResp.put_J(j);
            j = j + 1;
        }

        i = i + 1;
    }
    }

Curl Command

curl -X GET
	-H "X-API-Key: {{postman_api_key}}"
https://api.getpostman.com/mocks

Postman Collection Item JSON

{
  "name": "All Mocks",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.getpostman.com/mocks",
      "protocol": "https",
      "host": [
        "api",
        "getpostman",
        "com"
      ],
      "path": [
        "mocks"
      ]
    },
    "description": "This endpoint fetches all the mocks that you have created.\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",
          "protocol": "https",
          "host": [
            "api",
            "getpostman",
            "com"
          ],
          "path": [
            "mocks"
          ]
        }
      },
      "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    \"mocks\": [\n        {\n            \"id\": \"e782b64e-406b-4a6c-8fe9-9ebe84aeb706\",\n            \"owner\": \"1686168\",\n            \"uid\": \"1686168-e782b64e-406b-4a6c-8fe9-9ebe84aeb706\",\n            \"collection\": \"1686168-39fee52f-b806-3ffa-1173-00a6f5b183dc\",\n            \"environment\": \"1686168-2b90cdd8-e9ac-4086-91c2-bc4cad659511\",\n            \"mockUrl\": \"https://e782b64e-406b-4a6c-8fe9-9ebe84aeb706.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-15T06:44:37.000Z\",\n            \"updatedAt\": \"2020-12-15T06:44:37.000Z\",\n            \"isPublic\": false\n        },\n        {\n            \"id\": \"8f9d4b95-780d-455d-af38-772277bc9393\",\n            \"owner\": \"1686168\",\n            \"uid\": \"1686168-8f9d4b95-780d-455d-af38-772277bc9393\",\n            \"collection\": \"1686168-37eeb72f-5d3e-48b4-8022-6b9cca6d2664\",\n            \"mockUrl\": \"https://8f9d4b95-780d-455d-af38-772277bc93936.mock.pstmn.io\",\n            \"name\": \"mock2\",\n            \"config\": {\n                \"headers\": [],\n                \"matchBody\": false,\n                \"matchQueryParams\": true,\n                \"matchWildcards\": true,\n                \"delay\": null\n            },\n            \"createdAt\": \"2020-11-15T06:44:37.000Z\",\n            \"updatedAt\": \"2020-12-15T06:48:37.000Z\",\n            \"isPublic\": true\n        }\n    ]\n}"
    }
  ]
}