Chilkat Online Tools

phpAx / Postman API / Single Mock

Back to Collection Items

<?php

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

$http = new COM("Chilkat_9_5_0.Http");

$http->SetRequestHeader('X-API-Key','{{postman_api_key}}');

$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$success = $http->QuickGetSb('https://api.getpostman.com/mocks/{{mock_uid}}',$sbResponseBody);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

$jResp = new COM("Chilkat_9_5_0.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->LastStatus;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->LastHeader . "\n";
    print 'Failed.' . "\n";
    exit;
}

// 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 = $jResp->stringOf('mock.id');
$Owner = $jResp->stringOf('mock.owner');
$Uid = $jResp->stringOf('mock.uid');
$Collection = $jResp->stringOf('mock.collection');
$Environment = $jResp->stringOf('mock.environment');
$MockUrl = $jResp->stringOf('mock.mockUrl');
$Name = $jResp->stringOf('mock.name');
$MatchBody = $jResp->BoolOf('mock.config.matchBody');
$MatchQueryParams = $jResp->BoolOf('mock.config.matchQueryParams');
$MatchWildcards = $jResp->BoolOf('mock.config.matchWildcards');
$Delay = $jResp->stringOf('mock.config.delay');
$CreatedAt = $jResp->stringOf('mock.createdAt');
$UpdatedAt = $jResp->stringOf('mock.updatedAt');
$IsPublic = $jResp->BoolOf('mock.isPublic');
$i = 0;
$count_i = $jResp->SizeOfArray('mock.config.headers');
while ($i < $count_i) {
    $jResp->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}"
    }
  ]
}