Chilkat Online Tools

unicodeCpp / Salesforce Platform APIs / Create Named Credential

Back to Collection Items

#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkHttpResponseW.h>
#include <CkStringBuilderW.h>

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

    CkHttpW http;
    bool success;

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "developerName": "SamplePrivate",
    //   "masterLabel": "SamplePrivateLabel",
    //   "type": "SecuredEndpoint",
    //   "calloutUrl": "https://api.example.com",
    //   "externalCredentials": [
    //     {
    //       "developerName": "SampleExternalCredential"
    //     }
    //   ],
    //   "customHeaders": [
    //     {
    //       "headerName": "SampleHeader",
    //       "headerValue": "SampleValue",
    //       "sequenceNumber": 1
    //     }
    //   ],
    //   "calloutOptions": {
    //     "allowMergeFieldsInBody": false,
    //     "allowMergeFieldsInHeader": true,
    //     "generateAuthorizationHeader": true
    //   }
    // }

    CkJsonObjectW json;
    json.UpdateString(L"developerName",L"SamplePrivate");
    json.UpdateString(L"masterLabel",L"SamplePrivateLabel");
    json.UpdateString(L"type",L"SecuredEndpoint");
    json.UpdateString(L"calloutUrl",L"https://api.example.com");
    json.UpdateString(L"externalCredentials[0].developerName",L"SampleExternalCredential");
    json.UpdateString(L"customHeaders[0].headerName",L"SampleHeader");
    json.UpdateString(L"customHeaders[0].headerValue",L"SampleValue");
    json.UpdateInt(L"customHeaders[0].sequenceNumber",1);
    json.UpdateBool(L"calloutOptions.allowMergeFieldsInBody",false);
    json.UpdateBool(L"calloutOptions.allowMergeFieldsInHeader",true);
    json.UpdateBool(L"calloutOptions.generateAuthorizationHeader",true);

    // Adds the "Authorization: Bearer <access_token>" header.
    http.put_AuthToken(L"<access_token>");

    CkHttpResponseW *resp = http.PostJson3(L"https://domain.com/services/data/v{{version}}/named-credentials/named-credential-setup",L"application/json",json);
    if (http.get_LastMethodSuccess() == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    CkStringBuilderW sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObjectW jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",jResp.emit());

    int respStatusCode = resp->get_StatusCode();
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",resp->header());
        wprintf(L"Failed.\n");
        delete resp;
        return;
    }

    delete resp;

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

    // {
    //   "calloutOptions": {
    //     "allowMergeFieldsInBody": false,
    //     "allowMergeFieldsInHeader": true,
    //     "generateAuthorizationHeader": true
    //   },
    //   "calloutUrl": "https://api.example.com",
    //   "customHeaders": [
    //     {
    //       "headerName": "SampleHeader",
    //       "headerValue": "SampleValue",
    //       "id": "0pv2o000000PAv6AAG",
    //       "sequenceNumber": 1
    //     }
    //   ],
    //   "developerName": "SamplePrivate",
    //   "externalCredentials": [
    //     {
    //       "developerName": "SampleExternalCredential",
    //       "id": "0pt2o000000CaU0AAK",
    //       "masterLabel": "Sample External Credential",
    //       "url": "/services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential"
    //     }
    //   ],
    //   "id": "0XA2o000000XaAQGA0",
    //   "masterLabel": "SamplePrivateLabel",
    //   "parameters": [
    //   ],
    //   "type": "SecuredEndpoint",
    //   "url": "/services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate"
    // }

    // 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 wchar_t *headerName = 0;
    const wchar_t *headerValue = 0;
    int sequenceNumber;

    bool AllowMergeFieldsInBody = jResp.BoolOf(L"calloutOptions.allowMergeFieldsInBody");
    bool AllowMergeFieldsInHeader = jResp.BoolOf(L"calloutOptions.allowMergeFieldsInHeader");
    bool GenerateAuthorizationHeader = jResp.BoolOf(L"calloutOptions.generateAuthorizationHeader");
    const wchar_t *calloutUrl = jResp.stringOf(L"calloutUrl");
    const wchar_t *developerName = jResp.stringOf(L"developerName");
    const wchar_t *id = jResp.stringOf(L"id");
    const wchar_t *masterLabel = jResp.stringOf(L"masterLabel");
    const wchar_t *v_type = jResp.stringOf(L"type");
    const wchar_t *url = jResp.stringOf(L"url");
    int i = 0;
    int count_i = jResp.SizeOfArray(L"customHeaders");
    while (i < count_i) {
        jResp.put_I(i);
        headerName = jResp.stringOf(L"customHeaders[i].headerName");
        headerValue = jResp.stringOf(L"customHeaders[i].headerValue");
        id = jResp.stringOf(L"customHeaders[i].id");
        sequenceNumber = jResp.IntOf(L"customHeaders[i].sequenceNumber");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray(L"externalCredentials");
    while (i < count_i) {
        jResp.put_I(i);
        developerName = jResp.stringOf(L"externalCredentials[i].developerName");
        id = jResp.stringOf(L"externalCredentials[i].id");
        masterLabel = jResp.stringOf(L"externalCredentials[i].masterLabel");
        url = jResp.stringOf(L"externalCredentials[i].url");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray(L"parameters");
    while (i < count_i) {
        jResp.put_I(i);
        i = i + 1;
    }
    }

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
   "developerName": "SamplePrivate",
   "masterLabel": "SamplePrivateLabel",
   "type": "SecuredEndpoint",
   "calloutUrl": "https://api.example.com",
   "externalCredentials": [
      {
         "developerName": "SampleExternalCredential"
      }
   ],
   "customHeaders": [
      {
         "headerName": "SampleHeader",
         "headerValue": "SampleValue",
         "sequenceNumber": 1
      }
   ],
   "calloutOptions": {
      "allowMergeFieldsInBody": false,
      "allowMergeFieldsInHeader": true,
      "generateAuthorizationHeader": true
   }
}'
https://domain.com/services/data/v{{version}}/named-credentials/named-credential-setup

Postman Collection Item JSON

{
  "name": "Create Named Credential",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n   \"developerName\": \"SamplePrivate\",\n   \"masterLabel\": \"SamplePrivateLabel\",\n   \"type\": \"SecuredEndpoint\",\n   \"calloutUrl\": \"https://api.example.com\",\n   \"externalCredentials\": [\n      {\n         \"developerName\": \"SampleExternalCredential\"\n      }\n   ],\n   \"customHeaders\": [\n      {\n         \"headerName\": \"SampleHeader\",\n         \"headerValue\": \"SampleValue\",\n         \"sequenceNumber\": 1\n      }\n   ],\n   \"calloutOptions\": {\n      \"allowMergeFieldsInBody\": false,\n      \"allowMergeFieldsInHeader\": true,\n      \"generateAuthorizationHeader\": true\n   }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "named-credentials",
        "named-credential-setup"
      ]
    },
    "description": "Create a named credential."
  },
  "response": [
    {
      "name": "Successful Create Named Credential",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n   \"developerName\": \"SamplePrivate\",\n   \"masterLabel\": \"SamplePrivateLabel\",\n   \"type\": \"SecuredEndpoint\",\n   \"calloutUrl\": \"https://api.example.com\",\n   \"externalCredentials\": [\n      {\n         \"developerName\": \"SampleExternalCredential\"\n      }\n   ],\n   \"customHeaders\": [\n      {\n         \"headerName\": \"SampleHeader\",\n         \"headerValue\": \"SampleValue\",\n         \"sequenceNumber\": 1\n      }\n   ],\n   \"calloutOptions\": {\n      \"allowMergeFieldsInBody\": false,\n      \"allowMergeFieldsInHeader\": true,\n      \"generateAuthorizationHeader\": true\n   }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "named-credentials",
            "named-credential-setup"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 20 Nov 2023 16:54:12 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"calloutOptions\": {\n        \"allowMergeFieldsInBody\": false,\n        \"allowMergeFieldsInHeader\": true,\n        \"generateAuthorizationHeader\": true\n    },\n    \"calloutUrl\": \"https://api.example.com\",\n    \"customHeaders\": [\n        {\n            \"headerName\": \"SampleHeader\",\n            \"headerValue\": \"SampleValue\",\n            \"id\": \"0pv2o000000PAv6AAG\",\n            \"sequenceNumber\": 1\n        }\n    ],\n    \"developerName\": \"SamplePrivate\",\n    \"externalCredentials\": [\n        {\n            \"developerName\": \"SampleExternalCredential\",\n            \"id\": \"0pt2o000000CaU0AAK\",\n            \"masterLabel\": \"Sample External Credential\",\n            \"url\": \"/services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential\"\n        }\n    ],\n    \"id\": \"0XA2o000000XaAQGA0\",\n    \"masterLabel\": \"SamplePrivateLabel\",\n    \"parameters\": [],\n    \"type\": \"SecuredEndpoint\",\n    \"url\": \"/services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate\"\n}"
    }
  ]
}