Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; 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
; }
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("developerName","SamplePrivate")
$oJson.UpdateString("masterLabel","SamplePrivateLabel")
$oJson.UpdateString("type","SecuredEndpoint")
$oJson.UpdateString("calloutUrl","https://api.example.com")
$oJson.UpdateString("externalCredentials[0].developerName","SampleExternalCredential")
$oJson.UpdateString("customHeaders[0].headerName","SampleHeader")
$oJson.UpdateString("customHeaders[0].headerValue","SampleValue")
$oJson.UpdateInt("customHeaders[0].sequenceNumber",1)
$oJson.UpdateBool("calloutOptions.allowMergeFieldsInBody",False)
$oJson.UpdateBool("calloutOptions.allowMergeFieldsInHeader",True)
$oJson.UpdateBool("calloutOptions.generateAuthorizationHeader",True)
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
Local $oResp = $oHttp.PostJson3("https://domain.com/services/data/v{{version}}/named-credentials/named-credential-setup","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sHeaderName
Local $sHeaderValue
Local $iSequenceNumber
Local $bAllowMergeFieldsInBody = $oJResp.BoolOf("calloutOptions.allowMergeFieldsInBody")
Local $bAllowMergeFieldsInHeader = $oJResp.BoolOf("calloutOptions.allowMergeFieldsInHeader")
Local $bGenerateAuthorizationHeader = $oJResp.BoolOf("calloutOptions.generateAuthorizationHeader")
Local $sCalloutUrl = $oJResp.StringOf("calloutUrl")
Local $sDeveloperName = $oJResp.StringOf("developerName")
Local $sId = $oJResp.StringOf("id")
Local $sMasterLabel = $oJResp.StringOf("masterLabel")
Local $sV_type = $oJResp.StringOf("type")
Local $sUrl = $oJResp.StringOf("url")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("customHeaders")
While $i < $iCount_i
$oJResp.I = $i
$sHeaderName = $oJResp.StringOf("customHeaders[i].headerName")
$sHeaderValue = $oJResp.StringOf("customHeaders[i].headerValue")
$sId = $oJResp.StringOf("customHeaders[i].id")
$iSequenceNumber = $oJResp.IntOf("customHeaders[i].sequenceNumber")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("externalCredentials")
While $i < $iCount_i
$oJResp.I = $i
$sDeveloperName = $oJResp.StringOf("externalCredentials[i].developerName")
$sId = $oJResp.StringOf("externalCredentials[i].id")
$sMasterLabel = $oJResp.StringOf("externalCredentials[i].masterLabel")
$sUrl = $oJResp.StringOf("externalCredentials[i].url")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("parameters")
While $i < $iCount_i
$oJResp.I = $i
$i = $i + 1
Wend
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}"
}
]
}
