PureBasic / Postman API / Create API
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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
; 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.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"api.name","Sync Service API")
CkJsonObject::ckUpdateString(json,"api.summary","This is supposed to be a short summary.")
CkJsonObject::ckUpdateString(json,"api.description","This is description.")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"X-API-Key","{{postman_api_key}}")
resp.i = CkHttp::ckPostJson3(http,"https://api.getpostman.com/apis?workspace=c90a3482-f80d-43d6-9dfb-0830f5e43605","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
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 = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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.s = CkJsonObject::ckStringOf(jResp,"api.id")
Name.s = CkJsonObject::ckStringOf(jResp,"api.name")
Summary.s = CkJsonObject::ckStringOf(jResp,"api.summary")
Description.s = CkJsonObject::ckStringOf(jResp,"api.description")
CreatedBy.s = CkJsonObject::ckStringOf(jResp,"api.createdBy")
CreatedAt.s = CkJsonObject::ckStringOf(jResp,"api.createdAt")
UpdatedAt.s = CkJsonObject::ckStringOf(jResp,"api.updatedAt")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
