Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "api": {
// "name": "Sync Service API",
// "summary": "This is supposed to be a short summary.",
// "description": "This is description."
// }
// }
$json = new CkJsonObject();
$json->UpdateString('api.name','Sync Service API');
$json->UpdateString('api.summary','This is supposed to be a short summary.');
$json->UpdateString('api.description','This is description.');
$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('X-API-Key','{{postman_api_key}}');
// resp is a CkHttpResponse
$resp = $http->PostJson3('https://api.getpostman.com/apis?workspace=c90a3482-f80d-43d6-9dfb-0830f5e43605','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "api": {
// "id": "387c2863-6ee3-4a56-8210-225f774edade",
// "name": "Sync API",
// "summary": "This is a summary",
// "description": "This is supposed to handle markdown *descriptions*.",
// "createdBy": "5665",
// "createdAt": "2019-02-12 19:34:49",
// "updatedAt": "2019-02-12 19:34:49"
// }
// }
// 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('api.id');
$Name = $jResp->stringOf('api.name');
$Summary = $jResp->stringOf('api.summary');
$Description = $jResp->stringOf('api.description');
$CreatedBy = $jResp->stringOf('api.createdBy');
$CreatedAt = $jResp->stringOf('api.createdAt');
$UpdatedAt = $jResp->stringOf('api.updatedAt');
?>
Curl Command
curl -X POST
-H "X-API-Key: {{postman_api_key}}"
-H "Content-Type: application/json"
-d '{
"api": {
"name": "Sync Service API",
"summary": "This is supposed to be a short summary.",
"description": "This is description."
}
}'
https://api.getpostman.com/apis?workspace=c90a3482-f80d-43d6-9dfb-0830f5e43605
Postman Collection Item JSON
{
"name": "Create API",
"event": [
{
"listen": "test",
"script": {
"type": "text/javascript",
"exec": [
"const jsonData = pm.response.json();",
"",
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"pm.test(\"Should have valid response\", function () {",
" pm.expect(jsonData.data).to.include.all.keys('id', 'name', 'createdAt', 'createdBy', 'updatedAt', 'updatedBy');",
" ",
" pm.expect(jsonData.data.name).to.be.equal('New API');",
" pm.expect(jsonData.data.id).to.be.ok;",
" pm.expect(jsonData.data.createdAt).to.be.ok;",
" pm.expect(jsonData.data.createdBy).to.be.ok;",
" pm.expect(jsonData.data.updatedAt).to.be.ok;",
" pm.expect(jsonData.data.updatedBy).to.be.ok;",
"});",
"",
"pm.environment.set(\"apiId\", jsonData.data.id); "
]
}
}
],
"request": {
"method": "POST",
"header": [
{
"name": "Content-Type",
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"api\": {\n\t\t\"name\": \"Sync Service API\",\n\t\t\"summary\": \"This is supposed to be a short summary.\",\n\t\t\"description\": \"This is description.\"\n\t}\n}"
},
"url": {
"raw": "https://api.getpostman.com/apis?workspace=c90a3482-f80d-43d6-9dfb-0830f5e43605",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"apis"
],
"query": [
{
"key": "workspace",
"value": "c90a3482-f80d-43d6-9dfb-0830f5e43605"
}
]
},
"description": "This call creates a new API with a default API Version. \n\nRequest body should contain an `api` object which should atleast have a property `name`.\n\nResponse contains an `api` object with all the details related to the created API, namely, `id`, `name`, `summary`, `description`, etc. \n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
},
"response": [
{
"name": "Create API",
"originalRequest": {
"method": "POST",
"header": [
{
"name": "Content-Type",
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"api\": {\n\t\t\"name\": \"Sync Service API\",\n\t\t\"summary\": \"This is supposed to be a short summary.\",\n\t\t\"description\": \"This is description.\"\n\t}\n}"
},
"url": {
"raw": "https://api.getpostman.com/apis?workspace=c90a3482-f80d-43d6-9dfb-0830f5e43605",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"apis"
],
"query": [
{
"key": "workspace",
"value": "c90a3482-f80d-43d6-9dfb-0830f5e43605"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": {
"content": "",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n\t\"api\": {\n\t\t\"id\": \"387c2863-6ee3-4a56-8210-225f774edade\",\n\t\t\"name\": \"Sync API\",\n\t\t\"summary\": \"This is a summary\",\n\t\t\"description\": \"This is supposed to handle markdown *descriptions*.\",\n\t\t\"createdBy\": \"5665\",\n\t\t\"createdAt\": \"2019-02-12 19:34:49\",\n\t\t\"updatedAt\": \"2019-02-12 19:34:49\"\n\t}\n}"
}
]
}
