Chilkat Online Tools

PureBasic / Support API / Create Target

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

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "login")
    CkHttp::setCkPassword(http, "password")

    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    resp.i = CkHttp::ckQuickRequest(http,"POST","https://example.zendesk.com/api/v2/targets")
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        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)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

    ; Sample JSON response:
    ; (Sample code for parsing the JSON response is shown below)

    ; {
    ;   "target": {
    ;     "project_id": "<string>",
    ;     "resource": "<string>",
    ;     "target_url": "<string>",
    ;     "title": "<string>",
    ;     "token": "<string>",
    ;     "type": "<string>",
    ;     "active": "<boolean>",
    ;     "created_at": "<dateTime>",
    ;     "id": "<integer>",
    ;     "message_id": "<string>",
    ;     "password": "<string>",
    ;     "todo_list_id": "<string>",
    ;     "username": "<string>"
    ;   }
    ; }

    ; Sample code for parsing the JSON response...
    ; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    Project_id.s = CkJsonObject::ckStringOf(jResp,"target.project_id")
    Resource.s = CkJsonObject::ckStringOf(jResp,"target.resource")
    Target_url.s = CkJsonObject::ckStringOf(jResp,"target.target_url")
    Title.s = CkJsonObject::ckStringOf(jResp,"target.title")
    Token.s = CkJsonObject::ckStringOf(jResp,"target.token")
    v_Type.s = CkJsonObject::ckStringOf(jResp,"target.type")
    Active.s = CkJsonObject::ckStringOf(jResp,"target.active")
    Created_at.s = CkJsonObject::ckStringOf(jResp,"target.created_at")
    Id.s = CkJsonObject::ckStringOf(jResp,"target.id")
    Message_id.s = CkJsonObject::ckStringOf(jResp,"target.message_id")
    Password.s = CkJsonObject::ckStringOf(jResp,"target.password")
    Todo_list_id.s = CkJsonObject::ckStringOf(jResp,"target.todo_list_id")
    Username.s = CkJsonObject::ckStringOf(jResp,"target.username")


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

curl  -u login:password -X POST
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/targets

Postman Collection Item JSON

{
  "name": "Create Target",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/targets",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "targets"
      ]
    },
    "description": "#### Allowed For\n\n* Admins\n"
  },
  "response": [
    {
      "name": "Created response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/targets",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "targets"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"target\": {\n    \"project_id\": \"<string>\",\n    \"resource\": \"<string>\",\n    \"target_url\": \"<string>\",\n    \"title\": \"<string>\",\n    \"token\": \"<string>\",\n    \"type\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"created_at\": \"<dateTime>\",\n    \"id\": \"<integer>\",\n    \"message_id\": \"<string>\",\n    \"password\": \"<string>\",\n    \"todo_list_id\": \"<string>\",\n    \"username\": \"<string>\"\n  }\n}"
    }
  ]
}