Ability to interact with the CONXTD platform on behalf of a user's account. User will authorise your app to the data in their account. Access tokens and refresh tokens used as authenciation.
\n(Commerical charges and T&Cs may apply)
\nAccess Developer page
\nCreate app
\nThe system will create an app and provide you with a Client ID and Client Key. Ensure the save the Client Key somewhere safe as this will not get shown again.
\nPartner integrations will start on either Dev or Staging, as advised by CONXTD contact. Once CONXTD have approved integration, app can be deloyed on the live system.
\nBase 64 encoded {Client_id} + {Client_key}
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"grant_type","type":"text","value":"authorization_code"},{"key":"authorization_code","type":"text","value":"{authorizaion_code}"},{"key":"client_id","type":"text","value":"{client_id}"},{"key":"redirect_uri","type":"text","value":"{redirect_uri}"},{"key":"","type":"text","value":"","disabled":true}]},"url":"{{base-url}}/authake/oauth/token","description":"Once authorisation code has been obtained with the method above. Exhange the auth code for an access token.
\nAccess token can then be used as bearer token to interact with the CONXTD API.
\nAccess token expires after 24 hours. Refresh token can be used to generate a new access token.
\nOauth library process should be used here, call shown for technical understanding.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"96bad382-e1ea-4455-becf-941cdd769474","id":"96bad382-e1ea-4455-becf-941cdd769474","name":"Oauth","type":"folder"}},"urlObject":{"path":["authake","oauth","token"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"9a243cd7-cc65-4d6d-8633-4cf39638382a","name":"/Oauth/token","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic OTA4YjdjYTAtN2Q4MC00NzVhLTg5NWMtZjI4ZjRjMTNlNzg2NDYzNDNkNmFjNTZhM2I6NGEyZTdhOTExMTdkNzhiOTBjMjYzYWQwOTIyOTJlMzAxNjkyM2MzZQ==","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"grant_type","value":"authorization_code","type":"text"},{"key":"authorization_code","value":"01f7962d6343db163422d","type":"text"},{"key":"client_id","value":"908b7ca0-7d80-475a-895c-f28f4c13e78646343d6ac56a3b","type":"text"},{"key":"redirect_uri","value":"https://eoln3alk1le09rm.m.pipedream.net","type":"text"},{"key":"","value":"","type":"text","disabled":true}]},"url":"{{url}}/Oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 10 Oct 2022 08:58:38 GMT"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"x-permitted-cross-domain-policies","value":"all"},{"key":"referrer-policy","value":"same-origin"},{"key":"x-frame-options","value":"sameorigin"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"x-download-options","value":"noopen"},{"key":"x-content-type-options","value":"nosniff"},{"key":"Content-Length","value":"530"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"{access_token}\",\n \"token_type\": \"bearer\",\n \"refresh_token\": \"{refresh_token\",\n \"expires_in\": 86400,\n \"scope\": \"conxtd.api1665392318\"\n}"}],"_postman_id":"fddea690-3fc9-41ae-b3cc-1e9329dce554"},{"name":"Refresh Token","id":"37efa78d-bdac-49cc-84a6-06bc16ed71be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{base64_encoded}}","description":"Base 64 encoded {Client_id} + {Client_key}
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"grant_type","value":"refresh_token","type":"text"},{"key":"refresh_token","value":"{{refresh_token}}","type":"text"}]},"url":"{{base-url}}/authake/oauth/token","description":"After an access token expires, the refresh_token can be used to request a new access_token without the need to go through the full authorization_code workflow.
\nAt point of request existing access_token and refresh_token will expire. Response includes new access_token and new refresh_token.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"96bad382-e1ea-4455-becf-941cdd769474","id":"96bad382-e1ea-4455-becf-941cdd769474","name":"Oauth","type":"folder"}},"urlObject":{"path":["authake","oauth","token"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"fe882dd0-d0a4-4bdc-875c-e989d1f72826","name":"/Oauth/token","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic OTA4YjdjYTAtN2Q4MC00NzVhLTg5NWMtZjI4ZjRjMTNlNzg2NDYzNDNkNmFjNTZhM2I6NGEyZTdhOTExMTdkNzhiOTBjMjYzYWQwOTIyOTJlMzAxNjkyM2MzZQ==","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"grant_type","value":"refresh_token","type":"text"},{"key":"refresh_token","value":"{{refresh_token}}","type":"text"},{"key":"","value":"","type":"text","disabled":true}]},"url":"{{url}}/Oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 10 Oct 2022 08:58:38 GMT"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"x-permitted-cross-domain-policies","value":"all"},{"key":"referrer-policy","value":"same-origin"},{"key":"x-frame-options","value":"sameorigin"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"x-download-options","value":"noopen"},{"key":"x-content-type-options","value":"nosniff"},{"key":"Content-Length","value":"530"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"{access_token}\",\n \"token_type\": \"bearer\",\n \"refresh_token\": \"{refresh_token}\",\n \"expires_in\": 86400,\n \"scope\": \"conxtd.api1665392318\"\n}"}],"_postman_id":"37efa78d-bdac-49cc-84a6-06bc16ed71be"},{"name":"Request Access token - password grant type","id":"d1553079-3b0e-46f5-a201-539a98681f12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{base64_encoded}}","description":"Base 64 encoded {Client_id} + {Client_key}
\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text"},{"key":"email","value":"{email}","type":"text"},{"key":"password","value":"{password}","type":"text"}]},"url":"{{base-url}}/authake/oauth/token","description":"Alternative authentication method where username and password can be used to generate Access token and Refresh token.
\nFollowing intial authentication, refresh token can be used to generate new Access token.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"96bad382-e1ea-4455-becf-941cdd769474","id":"96bad382-e1ea-4455-becf-941cdd769474","name":"Oauth","type":"folder"}},"urlObject":{"path":["authake","oauth","token"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"de106772-f29d-4c83-96fa-18670c29f1fa","name":"Request Access token - password grant type","originalRequest":{"method":"POST","header":[{"description":"Base 64 encoded {Client_id} + {Client_key}","key":"Authorization","type":"text","value":"Basic {Base64_endcoded_client_credentials}"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","type":"text","value":"password"},{"key":"email","type":"text","value":"{email}"},{"key":"password","type":"text","value":"{Password}"}]},"url":{"raw":"{{base-url}}/authake/oauth/token","host":["{{base-url}}"],"path":["authake","oauth","token"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"{access_token}\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 86400,\n \"refresh_token\": \"{refresh_token}\",\n \"scope\": \"conxtd.com\"\n}"}],"_postman_id":"d1553079-3b0e-46f5-a201-539a98681f12"}],"id":"96bad382-e1ea-4455-becf-941cdd769474","description":"Once you've registered your app, you are ready to start interacting with the authentication process. This is used to login a user into CONXTD and for them to authorise your app access to their account. Subsequence authentication can be completed in the background with refresh token without the requirement for further user interaction.
\nProcess Flow:
\nGrant Type: Authorization Code
\nAuth URL: {url}/authake/oauth/authorize
\nAccess Token URL: {url}/authake/oauth/token
\nClient authentication: Send as Basic Auth Header (Client_ID:Client_Secret)
\nExample URL \nhttps://{url}/authake/oauth/authorize?response_type=code&state=&client_id={your_client_id}&scope=&redirect_uri={your_redirect_url}
\nRedirect URI\nhttps://{your_redirect_url}?code={authorisation_code}
\nBasic Auth Header
\nClient ID and Client Secret encoded in Base64
\nClient_id = ABC-123-456 \nClient_secret = qwerty12345
\nBefore Base64 Encode\nABC-123-456:qwerty12345
\nAfter encoding\nQUJDLTEyMy00NTY6cXdlcnR5MTIzNDU=
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"63fd72d2-82e0-491b-a3af-9af1f6bb2c50","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"29561f23-ad6e-45e5-9bbb-6c6523a8578c","type":"text/javascript","exec":[""]}}],"_postman_id":"96bad382-e1ea-4455-becf-941cdd769474"},{"name":"Resources","item":[{"name":"View Enterprises","id":"89ad3b19-8384-4fee-895c-68071ab8fd2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base-url}}/out_api/Enterprises/viewEnterprises","description":"Get all enterprises a user has access to. Response includes:
\nRequest using Enterprise ID. Gets all sites associated to enterprise.
\nResponse includes:
\nProvides list of CONXTD event library.
\nGet details of Enterprises and Sites user has access to.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Webhook URL
\n"},{"key":"enterprise_id","type":"text","value":"{{enterprise_id}}","description":"ID of enterprise
\n"},{"key":"enterprise_site_id","type":"text","value":"{{enterprise_Site_id}}","description":"ID of Enterprise Site
\n"}]},"url":"{{base-url}}/out_api/Webhooks/configWebhooks","description":"Register URL and configure what will be sent. Options currently are:
\nView webhooks registered to user account.
\n","urlObject":{"path":["out_api","Webhooks","viewWebhooks"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"a2ec292f-cbdb-4043-8a66-981cd23db9c5","name":"Webhooks/viewWebhooks","originalRequest":{"method":"GET","header":[],"url":"https://mars.conxtd.com/out_api/Webhooks/viewWebhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 17 Nov 2022 10:27:33 GMT"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"x-permitted-cross-domain-policies","value":"all"},{"key":"referrer-policy","value":"same-origin"},{"key":"x-frame-options","value":"sameorigin"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"x-download-options","value":"noopen"},{"key":"x-content-type-options","value":"nosniff"},{"key":"Content-Length","value":"401"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"url\": \"https://mars.conxtd.com/notifications/webhook/get-webhook-request\",\n \"enterprise_group\": null,\n \"enterprise_site\": {\n \"id\": 33438,\n \"name\": \"Divyahseel Test\"\n },\n \"enterprise\": {\n \"id\": 261,\n \"name\": \"Divyasheel logo test11\"\n }\n },\n {\n \"id\": 9,\n \"url\": \"https://mars.conxtd.com/notifications/webhook/get-webhook-request\",\n \"enterprise_group\": null,\n \"enterprise_site\": null,\n \"enterprise\": {\n \"id\": 240,\n \"name\": \"CSL Pro\"\n }\n }\n]"}],"_postman_id":"83cff7b3-2548-4af8-9dce-398fd5603669"},{"name":"Delete Webhooks","id":"40775d4e-5164-4d01-827a-fe58419db7cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{base-url}}/out_api/Webhooks/deleteWebhooks/{id}","description":"Delete a webhook associated to a user's account.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Amend the details of an existing webhook.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Example of webhook request made to your endpoint.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Following webhook registration, the system will start to heartbeat every 30 seconds using a HEAD request which expects a 200 Success response.
\nThis is to ensure the endpoint is active and used to calculate the avaliability percentage.
\nIt is possible to disable the heartbeat by contacting CONXTD, but we will then be unable to calculate avaliablity and the connection will not be compliant to EN50518 standard.
\n","urlObject":{"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"18626331-1c6d-4205-a91a-7d9855ba190c"}],"id":"0b64e1d0-81b4-4ebb-9799-88cc82b8551c","description":"Ability to recieve events from CONXTD system via webhook URL.
\nEach time an event occurs for configured site, a POST will be performed to your webhook URL.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"