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.put_BasicAuth(true);
http.put_Login("login");
http.put_Password("password");
http.SetRequestHeader("Accept","application/json");
CkStringBuilder sbResponseBody;
success = http.QuickGetSb("https://example.zendesk.com/api/v2/users/me",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)
// {
// "user": {
// "name": "<string>",
// "active": "<boolean>",
// "alias": "<string>",
// "chat_only": "<boolean>",
// "created_at": "<string>",
// "custom_role_id": "<integer>",
// "default_group_id": "<integer>",
// "details": "<string>",
// "email": "<string>",
// "external_id": "<string>",
// "iana_time_zone": "<string>",
// "id": "<integer>",
// "last_login_at": "<string>",
// "locale": "<string>",
// "locale_id": "<integer>",
// "moderator": "<boolean>",
// "notes": "<string>",
// "only_private_comments": "<boolean>",
// "organization_id": "<integer>",
// "phone": "<string>",
// "photo": {
// "dolore50": -51881550.25541992
// },
// "remote_photo_url": "<string>",
// "report_csv": "<boolean>",
// "restricted_agent": "<boolean>",
// "role": "<string>",
// "role_type": "<integer>",
// "shared": "<boolean>",
// "shared_agent": "<boolean>",
// "shared_phone_number": "<boolean>",
// "signature": "<string>",
// "suspended": "<boolean>",
// "tags": "<array>",
// "ticket_restriction": "<string>",
// "time_zone": "<string>",
// "two_factor_auth_enabled": "<boolean>",
// "updated_at": "<string>",
// "url": "<string>",
// "user_fields": {
// "deserunt_c4": -61141403
// },
// "verified": "<boolean>",
// "authenticity_token": "<string>"
// }
// }
// 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 *Name = jResp.stringOf("user.name");
const char *Active = jResp.stringOf("user.active");
const char *Alias = jResp.stringOf("user.alias");
const char *Chat_only = jResp.stringOf("user.chat_only");
const char *Created_at = jResp.stringOf("user.created_at");
const char *Custom_role_id = jResp.stringOf("user.custom_role_id");
const char *Default_group_id = jResp.stringOf("user.default_group_id");
const char *Details = jResp.stringOf("user.details");
const char *v_Email = jResp.stringOf("user.email");
const char *External_id = jResp.stringOf("user.external_id");
const char *Iana_time_zone = jResp.stringOf("user.iana_time_zone");
const char *Id = jResp.stringOf("user.id");
const char *Last_login_at = jResp.stringOf("user.last_login_at");
const char *Locale = jResp.stringOf("user.locale");
const char *Locale_id = jResp.stringOf("user.locale_id");
const char *Moderator = jResp.stringOf("user.moderator");
const char *Notes = jResp.stringOf("user.notes");
const char *Only_private_comments = jResp.stringOf("user.only_private_comments");
const char *Organization_id = jResp.stringOf("user.organization_id");
const char *Phone = jResp.stringOf("user.phone");
const char *Dolore50 = jResp.stringOf("user.photo.dolore50");
const char *Remote_photo_url = jResp.stringOf("user.remote_photo_url");
const char *Report_csv = jResp.stringOf("user.report_csv");
const char *Restricted_agent = jResp.stringOf("user.restricted_agent");
const char *Role = jResp.stringOf("user.role");
const char *Role_type = jResp.stringOf("user.role_type");
const char *v_Shared = jResp.stringOf("user.shared");
const char *Shared_agent = jResp.stringOf("user.shared_agent");
const char *Shared_phone_number = jResp.stringOf("user.shared_phone_number");
const char *Signature = jResp.stringOf("user.signature");
const char *Suspended = jResp.stringOf("user.suspended");
const char *Tags = jResp.stringOf("user.tags");
const char *Ticket_restriction = jResp.stringOf("user.ticket_restriction");
const char *Time_zone = jResp.stringOf("user.time_zone");
const char *Two_factor_auth_enabled = jResp.stringOf("user.two_factor_auth_enabled");
const char *Updated_at = jResp.stringOf("user.updated_at");
const char *v_Url = jResp.stringOf("user.url");
int Deserunt_c4 = jResp.IntOf("user.user_fields.deserunt_c4");
const char *Verified = jResp.stringOf("user.verified");
const char *Authenticity_token = jResp.stringOf("user.authenticity_token");
}
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/users/me
Postman Collection Item JSON
{
"name": "Show Self",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/me",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"me"
]
},
"description": "#### Allowed For\n\n* Anonymous users\n\n#### Authenticity Token\n\nThe endpoint returns an `authenticity_token`. Zendesk API calls made by end users from a Zendesk help center must include this token in the `X-CSRF-Token` HTTP header. This helps prevent [cross-site request forgery (CSRF)](https://en.wikipedia.org/wiki/Cross-site_request_forgery) attacks.\n\nFor an example using an authenticity token, see the AJAX request in the [Upgrading from Templating API v1](https://developer.zendesk.com/documentation/help_center/help-center-templates/v1#jquery) documentation.\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/me",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"me"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"user\": {\n \"name\": \"<string>\",\n \"active\": \"<boolean>\",\n \"alias\": \"<string>\",\n \"chat_only\": \"<boolean>\",\n \"created_at\": \"<string>\",\n \"custom_role_id\": \"<integer>\",\n \"default_group_id\": \"<integer>\",\n \"details\": \"<string>\",\n \"email\": \"<string>\",\n \"external_id\": \"<string>\",\n \"iana_time_zone\": \"<string>\",\n \"id\": \"<integer>\",\n \"last_login_at\": \"<string>\",\n \"locale\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"moderator\": \"<boolean>\",\n \"notes\": \"<string>\",\n \"only_private_comments\": \"<boolean>\",\n \"organization_id\": \"<integer>\",\n \"phone\": \"<string>\",\n \"photo\": {\n \"dolore50\": -51881550.25541992\n },\n \"remote_photo_url\": \"<string>\",\n \"report_csv\": \"<boolean>\",\n \"restricted_agent\": \"<boolean>\",\n \"role\": \"<string>\",\n \"role_type\": \"<integer>\",\n \"shared\": \"<boolean>\",\n \"shared_agent\": \"<boolean>\",\n \"shared_phone_number\": \"<boolean>\",\n \"signature\": \"<string>\",\n \"suspended\": \"<boolean>\",\n \"tags\": \"<array>\",\n \"ticket_restriction\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"two_factor_auth_enabled\": \"<boolean>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\",\n \"user_fields\": {\n \"deserunt_c4\": -61141403\n },\n \"verified\": \"<boolean>\",\n \"authenticity_token\": \"<string>\"\n }\n}"
}
]
}
