Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
$http.BasicAuth = $true
$http.Login = "username"
$http.Password = "password"
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "displayName": "My custom key"
# }
$json = New-Object Chilkat.JsonObject
$json.UpdateString("displayName","My custom key")
$http.SetRequestHeader("Content-Type","application/json")
$resp = $http.PostJson3("https://domain.com/v2/apps/{{appId}}/integrations/:integrationId/keys","application/json",$json)
if ($http.LastMethodSuccess -eq $false) {
$($http.LastErrorText)
exit
}
$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($resp.Header)
$("Failed.")
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "key": {
# "id": "int_5e4b0f225aca01092928f917",
# "displayName": "Duis",
# "secret": "Ck1LjzzlUzvlCTtqAdQ2z1QukuBTrN3TIx"
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$Id = $jResp.StringOf("key.id")
$DisplayName = $jResp.StringOf("key.displayName")
$Secret = $jResp.StringOf("key.secret")
Curl Command
curl -X POST
-u 'username:password'
-H "Content-Type: application/json"
-d '{
"displayName": "My custom key"
}'
https://domain.com/v2/apps/{{appId}}/integrations/:integrationId/keys
Postman Collection Item JSON
{
"name": "Create Integration Key",
"_postman_id": "e5aac223-5969-47fc-a918-bd03f1cb6b73",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"displayName\": \"My custom key\"\n}"
},
"url": {
"raw": "{{url}}/v2/apps/{{appId}}/integrations/:integrationId/keys",
"host": [
"{{url}}"
],
"path": [
"v2",
"apps",
"{{appId}}",
"integrations",
":integrationId",
"keys"
],
"variable": [
{
"key": "integrationId"
}
]
},
"description": "Creates an API key for the specified custom integration. The response body will include a secret as well it’s corresponding id, which you can use to generate JSON Web Tokens to securely make API calls on behalf of the integration."
},
"response": [
{
"id": "19226b7f-b998-4cf3-9853-23e1402564f3",
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer <token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"displayName\": \"My custom key\"\n}"
},
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/integrations/:integrationId/keys",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"integrations",
":integrationId",
"keys"
],
"variable": [
{
"key": "appId"
},
{
"key": "integrationId"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"key\": {\n \"id\": \"int_5e4b0f225aca01092928f917\",\n \"displayName\": \"Duis\",\n \"secret\": \"Ck1LjzzlUzvlCTtqAdQ2z1QukuBTrN3TIx\"\n }\n}"
}
]
}