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.
; {
; "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
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"developerName","SamplePrivate")
CkJsonObject::ckUpdateString(json,"masterLabel","SamplePrivateLabel")
CkJsonObject::ckUpdateString(json,"type","SecuredEndpoint")
CkJsonObject::ckUpdateString(json,"calloutUrl","https://api.example.com")
CkJsonObject::ckUpdateString(json,"externalCredentials[0].developerName","SampleExternalCredential")
CkJsonObject::ckUpdateString(json,"customHeaders[0].headerName","SampleHeader")
CkJsonObject::ckUpdateString(json,"customHeaders[0].headerValue","SampleValue")
CkJsonObject::ckUpdateInt(json,"customHeaders[0].sequenceNumber",1)
CkJsonObject::ckUpdateBool(json,"calloutOptions.allowMergeFieldsInBody",0)
CkJsonObject::ckUpdateBool(json,"calloutOptions.allowMergeFieldsInHeader",1)
CkJsonObject::ckUpdateBool(json,"calloutOptions.generateAuthorizationHeader",1)
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/services/data/v{{version}}/named-credentials/named-credential-setup","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)
; {
; "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
headerName.s
headerValue.s
sequenceNumber.i
AllowMergeFieldsInBody.i = CkJsonObject::ckBoolOf(jResp,"calloutOptions.allowMergeFieldsInBody")
AllowMergeFieldsInHeader.i = CkJsonObject::ckBoolOf(jResp,"calloutOptions.allowMergeFieldsInHeader")
GenerateAuthorizationHeader.i = CkJsonObject::ckBoolOf(jResp,"calloutOptions.generateAuthorizationHeader")
calloutUrl.s = CkJsonObject::ckStringOf(jResp,"calloutUrl")
developerName.s = CkJsonObject::ckStringOf(jResp,"developerName")
id.s = CkJsonObject::ckStringOf(jResp,"id")
masterLabel.s = CkJsonObject::ckStringOf(jResp,"masterLabel")
v_type.s = CkJsonObject::ckStringOf(jResp,"type")
url.s = CkJsonObject::ckStringOf(jResp,"url")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"customHeaders")
While i < count_i
CkJsonObject::setCkI(jResp, i)
headerName = CkJsonObject::ckStringOf(jResp,"customHeaders[i].headerName")
headerValue = CkJsonObject::ckStringOf(jResp,"customHeaders[i].headerValue")
id = CkJsonObject::ckStringOf(jResp,"customHeaders[i].id")
sequenceNumber = CkJsonObject::ckIntOf(jResp,"customHeaders[i].sequenceNumber")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"externalCredentials")
While i < count_i
CkJsonObject::setCkI(jResp, i)
developerName = CkJsonObject::ckStringOf(jResp,"externalCredentials[i].developerName")
id = CkJsonObject::ckStringOf(jResp,"externalCredentials[i].id")
masterLabel = CkJsonObject::ckStringOf(jResp,"externalCredentials[i].masterLabel")
url = CkJsonObject::ckStringOf(jResp,"externalCredentials[i].url")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"parameters")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
