{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"31ba522c-93bf-4e3e-aca1-662cd7cf36af","name":"Konducter API","description":"The Konducter API resources include a combination of both local endpoints, cloud endpoints, and webhooks.\n\n## **Getting started**\n\nTo start using the Konducter API or webhooks, you must have the following:\n\n- Your application must be defined in the Konducter Portal, and enabled as an Integration for the brand the site belongs to.\n    \n- Site, AccessKey, and AccessSecret values will be available in the Konducter Portal.\n    \n    - To call API resources, the Application must be configured to allow access to to particular services that are required.\n        \n    - To consume webhooks, a valid handler URL must be defined and the relavant event triggers enabled.\n        \n- The API returns responses in JSON format. When an API request returns an error, it returns an HTTP status code only, with no response body.\n    \n- All API endpoints are case sensitive, and paths must match exactly as documented.\n    \n\nConsider whether your application is configured as public or private within the Konducter platform. Public applications, available to all organizations, will use the same keys for all enabled integrations, whereas private applications are restricted to a single organization.\n\n## Rate Limiting\n\nAll cloud APIs and incoming webhook calls are subject to rate limiting policies. These policies vary by endpoint and are determined based on the context, including header values for API endpoints and application/brand identifiers for incoming webhook calls.\n\nIf you receive a `429 Too Many Requests` response, your integration should handle it gracefully by implementing appropriate retry logic to stay within the allowed rate limits.\n\nAll responses to API calls subject to rate limiting will include the following headers, which inform the caller of the applicable rate limit thresholds and remaining request counts within both one-second and one-minute windows.\n\n| **Header** | **Description** |\n| --- | --- |\n| **x-ratelimit-remaining-minute** | Indicates the number of remaining requests the client can make in the current one-minute window before hitting the rate limit. |\n| **x-ratelimit-remaining-second** | Indicates the number of remaining requests the client can make in the current one-second window. |\n| **x-ratelimit-limit-minute** | Specifies the maximum number of requests allowed per client in a one-minute window. |\n| **x-ratelimit-limit-second** | Specifies the maximum number of requests allowed per client in a one-second window. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"38779639","team":9080245,"collectionId":"31ba522c-93bf-4e3e-aca1-662cd7cf36af","publishedId":"2sAXxLCuos","public":true,"publicUrl":"https://documenter-api.postman.tech/view/38779639/2sAXxLCuos","privateUrl":"https://go.postman.co/documentation/38779639-31ba522c-93bf-4e3e-aca1-662cd7cf36af","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"cc3333"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"Konducter API Documentation"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/303296f7-7a9e-4efa-96ef-45e6e680829d/S29uZHVjdGVyLUxvZ28tUG9zdG1hbi1XaGl0ZS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"cc3333"}},{"name":"light","logo":"https://content.pstmn.io/abafaf9a-0293-4eba-9aaf-dff1deb08415/S29uZHVjdGVyLUxvZ28tUG9zdG1hbi5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"cc3333"}}]}},"version":"8.10.1","publishDate":"2025-04-25T13:13:39.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Konducter API Documentation","description":""},"logos":{"logoLight":"https://content.pstmn.io/abafaf9a-0293-4eba-9aaf-dff1deb08415/S29uZHVjdGVyLUxvZ28tUG9zdG1hbi5wbmc=","logoDark":"https://content.pstmn.io/303296f7-7a9e-4efa-96ef-45e6e680829d/S29uZHVjdGVyLUxvZ28tUG9zdG1hbi1XaGl0ZS5wbmc="}},"statusCode":200},"environments":[{"name":"Documentation Public","id":"889bca9c-4ed4-4ad8-8e68-026dd6903fcc","owner":"38779639","values":[{"key":"AccessKey","value":"12345","enabled":true,"type":"secret"},{"key":"AccessSecret","value":"12345","enabled":true,"type":"secret"},{"key":"LocalHostname","value":"192.168.1.100","enabled":true,"type":"default"},{"key":"LocalPort","value":"22288","enabled":true,"type":"default"},{"key":"SiteId","value":"00000000-0000-0000-0000-000000000000","enabled":true,"type":"default"},{"key":"CloudHostname","value":"api.konducter.com","enabled":true,"type":"default"},{"key":"OrderId","value":"00000000-0000-0000-0000-000000000000","enabled":true,"type":"default"},{"key":"BrandId","value":"00000000-0000-0000-0000-000000000000","enabled":true,"type":"default"},{"key":"ApplicationId","value":"00000000-0000-0000-0000-000000000000","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/8d909cfa174e8896f360c27032e0990c701911f11de4035160b4e2aaccfe7f65","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Documentation Public","value":"38779639-889bca9c-4ed4-4ad8-8e68-026dd6903fcc"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAXxLCuos"}