Versions Compared

Old Version 25

changes.mady.by.user Natalia Yudnikova

Saved on

compared with

New Version Current

changes.mady.by.user Natalia Yudnikova

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

PRD - https://canvas.connectmyapps.com/api

IP restriction

You can send Canvas REST API requests from any server by default.

If you want to restict access by IP addresses, then please provide your IP addresses to ConnectMyApps support for adding them into white list.

Authentication

For enabling of access to your organization data by REST API you need to set <API access> flag ON and copy provided Secret and Consumer keys. These keys are for access to Canvas REST API and you will use them in request headers. Do not share provided keys with anybody and keep them in safe place because they are not saved in Canvas and you will not be able to get them anymore.

Authentication requestUse following authentication request for checking your access keys:

Expand
titleGET https://<base-url>/Authenticate

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED
SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

Expand
titleResponse (status 200)
Expand
Code Block
{
  "access_token": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzYzI4YjFkYy05ZDA1LTQ5ZDgtYTMyNC1kNGI2N2IxYTg3MmQiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODA4MiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY4OTgxLCJhdWQiOiJjbWEtdXNlcnMifQ.SllrAi0m1DR__9tYuSZJ4-qTk3pnxEi2G5vs6_cSvCE",
  "accessTokenExpiresDateTime": "2022-04-27T14:16:21.9458102+00:00",
  "refresh_token": "6ed6d7ba271d43a0843f8f363fe27279",     
  "refreshTokenExpiresDateTime": "2022-04-28T14:01:21.9458102+00:00"
}
Expand
titleResponse (status 401)

Returned if the Consumer or SecretKey are incorrect or missing.

Refresh token

For refreshing of access token you need to send following request:

languagejson
true
Expand
titleResponse (status 401)

Returned if the Consumer or SecretKey are incorrect or missing.

APIs for help

There are two APIs, which describes list of all provided APIs

GetMetaData

For getting of all provided APIs you need to send following request:

Expand
titleGET https://<base-url>/RefreshAccessToken?refreshToken=6ed6d7ba271d43a0843f8f363fe27279GetMetaData

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED
SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

no header

[ { "id": "3c2da999-deca-4d16-b9a5-004bc1d5e0f9", "name": "Arrow", "shortName": "ARSP", "description": "Cloud delivery and administration", "vendorUrl": "https://www.arrow.com/ecs/no/loesninger/sky/arrowsphere/", "credentialFields": "[\r\n {\r\n \"ShortName\": \"apiKey\",\r\n \"Name\": \"API key\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Arrowsphere API key.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"environment\",\r\n \"Name\": \"Environment\",\r\n \"Type\": \"select\",\r\n \"Value\": \"\",\r\n \"Options\": \"live|Live Environment,test|Test Environment\",\r\n \"Optional\": false,\r\n \"Desc\": \"Choose which Arrowsphere environment you wish to use, live or test.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "Cloud", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "07ffd13d-ba57-4d1b-9c46-03c5c919eed0", "name": "Talentsoft", "shortName": "TASO", "description": "HR", "vendorUrl": "https://www.talentsoft.com/", "credentialFields": "[\r\n {\r\n \"ShortName\": \"baseUrl\",\r\n \"Name\": \"Base url\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Talentsoft API url.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"client_id\",\r\n \"Name\": \"Client ID\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Talentsoft client ID.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"client_secret\",\r\n \"Name\": \"Client secret\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Talentsoft client secret.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "Hr, Premium", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "2ad9b4c5-d40d-46ac-8cd2-0dae50337693", "name": "Planday", "shortName": "PLAN", "description": "Workforce managment", "vendorUrl": "https://www.planday.com/", "credentialFields": "[\r\n {\r\n \"ShortName\": \"appid\",\r\n \"Name\": \"Application Id\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Planday application Id\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"token\",\r\n \"Name\": \"Token\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Token\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "Planday API", "sessionTimeMins": 45, "sessionSlidingExpiry": false }, { "id": "720b3e57-c399-4531-8aa7-0f27b3ea99fa", "name": "SalesScreen", "shortName": "SASC", "description": "Sales visualization", "vendorUrl": "http://www.dogu.no", "credentialFields": "[\r\n {\r\n \"ShortName\": \"key\",\r\n \"Name\": \"Company key\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your SalesScreen API company key.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "Sales", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "40c47b6f-2e4c-49e4-922d-114f0d3abcf6", "name": "Magento", "shortName": "MAGF", "description": "E-commerce", "vendorUrl": "https://www.magentocommerce.com/", "credentialFields": "[\r\n {\r\n \"ShortName\": \"username\",\r\n \"Name\": \"User name\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Magento user name.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"password\",\r\n \"Name\": \"Password\",\r\n \"Type\": \"password\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Magento password.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"url\",\r\n \"Name\": \"Store url\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Magento store API url.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "E-Commerce", "sessionTimeMins": 15, "sessionSlidingExpiry": false }, { "id": "0124c014-0d7a-452e-b264-1911a891db96", "name": "Matchi", "shortName": "MATC", "description": "Booking", "vendorUrl": "https://www.matchi.se/", "credentialFields": "[\r\n {\r\n \"ShortName\": \"apikey\",\r\n \"Name\": \"API key\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Matchi API key.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "Booking", "sessionTimeMins": 10, "sessionSlidingExpiry": false }, { "id": "4773ffe3-489c-4daf-99f3-1d57bd9fa3dc", "name": "Microsoft Active Directory", "shortName": "MSAD", "description": "User Management", "vendorUrl": "https://www.microsoft.com", "credentialFields": "[\r\n {\r\n \"ShortName\": \"server\",\r\n \"Name\": \"Server name\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your SQL server.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"user\",\r\n \"Name\": \"SQL user\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your SQL database user.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"password\",\r\n \"Name\": \"SQL password\",\r\n \"Type\": \"password\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your SQL database password.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"connectorkey\",\r\n \"Name\": \"CloudConnector key\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your CloudConnector key.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "MS Active Directory", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "bf4a4646-75eb-4f79-a3c4-2101540c4ca5", "name": "File Sync", "shortName": "CMFF", "description": "File transfer", "vendorUrl": "http://www.connectmyapps.com", "credentialFields": "[\r\n {\r\n \"ShortName\": \"connectorkey\",\r\n \"Name\": \"Connector key\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your CMFF connector key.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "Files", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "89fe81b5-f8a3-4a95-9510-28984ea815d4", "name": "Amazon (Europe)", "shortName": "AMAZ", "description": "E-commerce", "vendorUrl": "NA", "credentialFields": "[\r\n {\r\n \"ShortName\": \"sellerId\",\r\n \"Name\": \"Seller ID\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your seller id.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"authToken\",\r\n \"Name\": \"MWS authorization token\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your mws authorization token.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "Amazon API", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "d483aeca-cecf-4ba4-b616-322c632e30fb", "name": "Visma .NET Financials", "shortName": "VISF", "description": "ERP and financial", "vendorUrl": "https://signin.visma.net/", "credentialFields": "[\r\n {\r\n \"ShortName\": \"username\",\r\n \"Name\": \"User name\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Visma Financials user name\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"password\",\r\n \"Name\": \"Password\",\r\n \"Type\": \"password\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Visma Financials password\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"client\",\r\n \"Name\": \"Company\",\r\n \"Type\": \"select\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Visma Financials name\",\r\n \"Hidden\": false,\r\n \"IsTwoStepsAuth\": true\r\n },\r\n {\r\n \"ShortName\": \"token\",\r\n \"Name\": \"Token\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": true,\r\n \"Desc\": \"Your Visma Financials token\",\r\n \"Hidden\": true\r\n }\r\n]", "tag": "ERP,Financials,Cloud,Premium", "sessionTimeMins": 10, "sessionSlidingExpiry": false }, { "id": "3bbd2af7-73ae-4fb2-8427-39209b6cfbf8", "name": "24SevenOffice", "shortName": "TFSO", "description": "ERP and accounting", "vendorUrl": "http://www.24sevenoffice.com/uk", "credentialFields": "[\r\n {\r\n \"ShortName\": \"username\",\r\n \"Name\": \"User name\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your 24seven Office API user name.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"password\",\r\n \"Name\": \"Password\",\r\n \"Type\": \"password\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your 24seven Office API password.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"client\",\r\n \"Name\": \"Client\",\r\n \"Type\": \"select\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your 24seven Office client name.\",\r\n \"Hidden\": false,\r\n \"IsTwoStepsAuth\": true\r\n }\r\n]", "tag": "ERP, CRM", "sessionTimeMins": 15, "sessionSlidingExpiry": true }, { "id": "ab3410a6-daca-40fd-94f5-4736e7030abd", "name": "Woo Commerce", "shortName": "WOOC", "description": "E-commerce", "vendorUrl": "http://www.wordpress.com", "credentialFields": "[\r\n {\r\n \"ShortName\": \"consumerKey\",\r\n \"Name\": \"Consumer key\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Woocommerce API consumer key.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"consumerSecret\",\r\n \"Name\": \"Consumer secret\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Woocommerce API consumer secret.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"url\",\r\n \"Name\": \"API url\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Woocommerce API HTTPS url.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"version_no\",\r\n \"Name\": \"API version\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": true,\r\n \"Desc\": \"Woocommerce API version (v1 by default).\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "webshop,e-commerce", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "6f4c634b-373f-4077-8a8b-4eaa873dc23b", "name": "Visma Payroll and Employee", "shortName": "VIPA", "description": "Payroll and HR", "vendorUrl": null, "credentialFields": "[\r\n {\r\n \"ShortName\": \"tenantid\",\r\n \"Name\": \"Tenant Id\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Visma Tenant Id\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "Accounting, HR, Cloud", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "b49dd46d-973f-486e-aa4d-53d394520c38", "name": "Hibob", "shortName": "HIBO", "description": "HR Management", "vendorUrl": "https://www.hibob.com/", "credentialFields": "[\r\n {\r\n \"ShortName\": \"apitoken\",\r\n \"Name\": \"API token\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Hibob API token.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "HR", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "5f814909-01ea-4395-96ee-5ba7614128fc", "name": "FTP Server", "shortName": "FTP", "description": "File upload and download", "vendorUrl": "NA", "credentialFields": "[\r\n {\r\n \"ShortName\": \"username\",\r\n \"Name\": \"User name\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your FTP user name.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"password\",\r\n \"Name\": \"Password\",\r\n \"Type\": \"password\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your FTP password.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"port\",\r\n \"Name\": \"Port\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your FTP server port.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"address\",\r\n \"Name\": \"Server address\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your FTP server address.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"secure\",\r\n \"Name\": \"Secure\",\r\n \"Type\": \"select\",\r\n \"Value\": \"\",\r\n \"Options\": \"secure|Secure (SFTP/SSH),false| Not secure FTP\",\r\n \"Optional\": false,\r\n \"Desc\": \"Choose whether your FTP server requires a secure connection.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "File server", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "d88a7340-b6b7-44dc-b56b-5cf6f45bdff3", "name": "KashFlow", "shortName": "KASH", "description": "Accounting", "vendorUrl": "http://www.kashflow.com/", "credentialFields": "KASH: Invalid Application.CredentialsTemplateJson. After parsing a value an unexpected character was encountered: E. Path 'Info', line 1, position 165.", "tag": "Accounting", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "c84f7b1c-1b24-42eb-86a3-60d8339c7ac9", "name": "Zoined", "shortName": "ZOIN", "description": "Analytics", "vendorUrl": "https://www.zoined.com/", "credentialFields": "[\r\n {\r\n \"ShortName\": \"ZOINToken\",\r\n \"Name\": \"Authentication token\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Zoined auth token\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "Analytics", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "fdcdc1fe-3a9f-4eed-89b6-654da2bf1bf0", "name": "Xledger", "shortName": "XLED", "description": "ERP and accounting", "vendorUrl": "http://www.xledger.no/", "credentialFields": "[\r\n {\r\n \"ShortName\": \"username\",\r\n \"Name\": \"User name\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Xledger API user name.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"password\",\r\n \"Name\": \"Password\",\r\n \"Type\": \"password\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Xledger API password.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"entitycode\",\r\n \"Name\": \"Entity code\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Xledger API entity code.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"environment\",\r\n \"Name\": \"Environment\",\r\n \"Type\": \"select\",\r\n \"Value\": \"\",\r\n \"Options\": \"live|Live Environment,test|Test Environment,demo|Demo Environment\",\r\n \"Optional\": false,\r\n \"Desc\": \"Choose which Xledger environment you wish to use, live or test.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"usecertificate\",\r\n \"Name\": \"Use certificate\",\r\n \"Type\": \"select\",\r\n \"Value\": \"\",\r\n \"Options\": \"yes|Yes,no|No\",\r\n \"Optional\": true,\r\n \"Desc\": \"Choose if you want use certificate or not\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "Accounting, ERP,Premium", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "eafaa805-7a36-40b5-bc3c-698fd84469ca", "name": "E-Works Manager", "shortName": "EWOR", "description": "Job management", "vendorUrl": null, "credentialFields": "[\r\n {\r\n \"ShortName\": \"key\",\r\n \"Name\": \"API key\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your E-Works Manager API company key.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "job, project, sales", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "9b6a04b3-c91f-4255-9033-6ac7b7a6f935", "name": "File Hub", "shortName": "CMAF", "description": "File automation", "vendorUrl": null, "credentialFields": "[]", "tag": "Files, Import, Export", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "249406f5-d335-4822-a053-6c4c6ccdd7df", "name": "Absence.IO", "shortName": "ABIO", "description": "Employee absence management", "vendorUrl": "https://www.absence.io", "credentialFields": "[\r\n {\r\n \"ShortName\": \"id\",\r\n \"Name\": \"Id\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your API Id.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"key\",\r\n \"Name\": \"Key\",\r\n \"Type\": \"password\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your API key.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "Absence.IO", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "e7ba6491-c3e2-4c1e-87e0-73bd604ef7ff", "name": "Talent Recruiter", "shortName": "HTRE", "description": "Recruitment system", "vendorUrl": "http://www.hr-manager.net", "credentialFields": "[\r\n {\r\n \"ShortName\": \"customeralias\",\r\n \"Name\": \"Customer alias\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your customer alias.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"apikey\",\r\n \"Name\": \"Your API key\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your API key.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "HR", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "8133bb05-57fa-4456-ae04-7537e4157d35", "name": "Hosted Microsoft SQL", "shortName": "HSQL", "description": "Database engine", "vendorUrl": "http://www.microsoft.com", "credentialFields": "[\r\n {\r\n \"ShortName\": \"server\",\r\n \"Name\": \"Server name\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your SQL server.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"database\",\r\n \"Name\": \"Database name\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": true,\r\n \"Desc\": \"Your SQL database name\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"user\",\r\n \"Name\": \"SQL user\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your SQL database user.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"password\",\r\n \"Name\": \"SQL password\",\r\n \"Type\": \"password\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your SQL database password.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "Database Engine,Premium", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "618018ca-932b-48fc-9492-753e1f079922", "name": "Nexmo", "shortName": "NEXM", "description": "SMS messaging", "vendorUrl": "NA", "credentialFields": "[\r\n {\r\n \"ShortName\": \"apikey\",\r\n \"Name\": \"API key\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Nexmo API key.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"apisecret\",\r\n \"Name\": \"API secret\",\r\n \"Type\": \"password\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Nexmo API secret.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "Nexmo SMS", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "f3169b4c-59d4-4762-b775-755c98add09f", "name": "MyStore", "shortName": "MYST2", "description": "E-commerce v2.0", "vendorUrl": "http://www.mystore.no", "credentialFields": "[\r\n {\r\n \"ShortName\": \"apitoken\",\r\n \"Name\": \"API token\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your API token.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"shopname\",\r\n \"Name\": \"Shop name\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your shop name.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "Webshop,E-commerce", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "4fa815e0-ef16-4873-94c6-7b83fc1c2958", "name": "Zendesk", "shortName": "ZEND", "description": "Helpdesk", "vendorUrl": "http://www.zendesk.com/", "credentialFields": "[\r\n {\r\n \"ShortName\": \"useremail\",\r\n \"Name\": \"User email\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Zendesk user email.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"password\",\r\n \"Name\": \"Password\",\r\n \"Type\": \"password\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Zendesk password.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"url\",\r\n \"Name\": \"Helpdesk url\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Zendesk support site url.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "Helpdesk", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "1d7b84ef-0d1d-4540-a3c2-7da4ebf1e5c5", "name": "DDD Retail POS", "shortName": "DDDR", "description": "Point of sale", "vendorUrl": null, "credentialFields": "[\r\n {\r\n \"ShortName\": \"apitoken\",\r\n \"Name\": \"API token\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your API token.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "POS,Web", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "234b64e8-2656-4a10-bb00-7ede8968ab60", "name": "Dynamics 365 HR", "shortName": "D365", "description": "Dynamics 365 HR", "vendorUrl": "https://dynamics.microsoft.com/en-us/human-resources/overview/", "credentialFields": "[\r\n {\r\n \"ShortName\": \"clientId\",\r\n \"Name\": \"Client ID\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your D365HR client ID.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"clientSecret\",\r\n \"Name\": \"Client secret\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your D365HR client secret.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"tenantId\",\r\n \"Name\": \"Tenant ID\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your D365HR tenant ID.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"cluster\",\r\n \"Name\": \"Cluster name\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your D365HR cluster name.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"namespaceId\",\r\n \"Name\": \"Namespace ID\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your D365HR namespace ID.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "D365", "sessionTimeMins": 55, "sessionSlidingExpiry": false }, { "id": "1e4e9863-f2cd-462e-a80a-80821546ba1b", "name": "FTP Key file", "shortName": "FTPC", "description": "File upload and download", "vendorUrl": "", "credentialFields": "[\r\n {\r\n \"ShortName\": \"address\",\r\n \"Name\": \"Server address\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your FTP server address.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"username\",\r\n \"Name\": \"User name\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": true,\r\n \"Desc\": \"Your FTP user name.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"keyfile\",\r\n \"Name\": \"Key file (Base64)\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Key file (Base64)\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"keypass\",\r\n \"Name\": \"Passphrase (optional)\",\r\n \"Type\": \"password\",\r\n \"Value\": \"\",\r\n \"Optional\": true,\r\n \"Desc\": \"Your FTP password.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"port\",\r\n \"Name\": \"Port\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your FTP server port.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "File server", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "7240f3f7-0e5d-4dfc-a784-81bff898fc0a", "name": "CatalystOne REST API", "shortName": "CATO2", "description": "CatalystOne API v3", "vendorUrl": "https://www.catalystone.com/", "credentialFields": "[\r\n {\r\n \"ShortName\": \"clientid\",\r\n \"Name\": \"Client Id\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Unique client key\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"clientsecret\",\r\n \"Name\": \"Client secret\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Client secret Key\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"clientname\",\r\n \"Name\": \"Client name\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Client name\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"server\",\r\n \"Name\": \"Server\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Server\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "HR", "sessionTimeMins": 45, "sessionSlidingExpiry": false }, { "id": "58efd99e-d2e5-4fca-8bdc-889f303c92f1", "name": "Prosperworks CRM", "shortName": "PROS", "description": "CRM", "vendorUrl": "https://www.prosperworks.com/", "credentialFields": "[\r\n {\r\n \"ShortName\": \"apiKey\",\r\n \"Name\": \"API key\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Prosperworks CRM API key.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"emailAddress\",\r\n \"Name\": \"Email address\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Prosperworks CRM email address\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "CRM", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "95f5442f-5fdc-4899-bb99-8deed7099a03", "name": "Smart Recruiters", "shortName": "SREC", "description": "Recruitment.", "vendorUrl": "https://www.smartrecruiters.com/", "credentialFields": "[\r\n {\r\n \"ShortName\": \"apitoken\",\r\n \"Name\": \"API token\",\r\n \"Type\": \"password\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your API token.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "Smart Recruiters", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "ed0f17f9-8f5c-46e3-a12c-8f6f248175e7", "name": "Magento 2", "shortName": "MAG2", "description": "E-commerce", "vendorUrl": "https://www.magentocommerce.com/", "credentialFields": "[\r\n {\r\n \"ShortName\": \"username\",\r\n \"Name\": \"User name\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Magento user name.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"password\",\r\n \"Name\": \"Password\",\r\n \"Type\": \"password\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Magento password.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"url\",\r\n \"Name\": \"Store url\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Magento store API url.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "E-Commerce", "sessionTimeMins": 300, "sessionSlidingExpiry": false }, { "id": "228ad895-0137-4fa9-8dfd-9463bf771f81", "name": "Azure Blob Storage", "shortName": "AZBL", "description": "Cloud Storage", "vendorUrl": "https://www.microsoft.com/", "credentialFields": "[\r\n {\r\n \"ShortName\": \"connstring\",\r\n \"Name\": \"Connection string\",\r\n \"Type\": \"\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your connection string copied from key1\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "Cloud Storage", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "3a3b090f-caed-41a3-a9d9-94ef4fa62e8e", "name": "Mobile Worker", "shortName": "MOBW", "description": "Job management", "vendorUrl": "NA", "credentialFields": "[\r\n {\r\n \"ShortName\": \"username\",\r\n \"Name\": \"User name\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your mobile worker user name.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"password\",\r\n \"Name\": \"Password\",\r\n \"Type\": \"password\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your mobile worker password.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "Job management", "sessionTimeMins": 6, "sessionSlidingExpiry": true }, { "id": "ce6d366a-a96a-4ec7-bdd6-97de320383bb", "name": "Smartdok", "shortName": "SMDK", "description": "Job management", "vendorUrl": "http://www.smartdok.no", "credentialFields": "[\r\n {\r\n \"ShortName\": \"username\",\r\n \"Name\": \"User name\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your user name\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"password\",\r\n \"Name\": \"Password\",\r\n \"Type\": \"password\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your password\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "Job management,Premium", "sessionTimeMins": 0, "sessionSlidingExpiry": false }, { "id": "866c4fd4-82f2-4e8d-b1a4-9e082a648a6a", "name": "Web Expenses", "shortName": "WEBX", "description": "Web Expenses", "vendorUrl": "https://logon.bluegarden.dk/?applicationname=DI", "credentialFields": "[\r\n {\r\n \"ShortName\": \"username\",\r\n \"Name\": \"Email address\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Webexpenses email address.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"password\",\r\n \"Name\": \"Password\",\r\n \"Type\": \"password\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Webexpenses password.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"clientId\",\r\n \"Name\": \"Client ID\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Webexpenses client ID.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"clientSecret\",\r\n \"Name\": \"Client secret\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Webexpenses client secret.\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "DATL", "sessionTimeMins": 700, "sessionSlidingExpiry": false }, { "id": "8d9110bf-e04b-4323-9d94-a0326911aeb6", "name": "Fiken", "shortName": "FIKE", "description": "Accounting", "vendorUrl": "http://www.fiken.no", "credentialFields": "[\r\n {\r\n \"ShortName\": \"username\",\r\n \"Name\": \"User name\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Fiken user name.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"password\",\r\n \"Name\": \"Password\",\r\n \"Type\": \"password\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Fiken password.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"company\",\r\n \"Name\": \"Company\",\r\n \"Type\": \"select\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Fiken company name.\",\r\n \"Hidden\": false,\r\n \"IsTwoStepsAuth\": true\r\n }\r\n]
Expand
titleResponse (status 200)
Expand
titleResponse (status 200)
Code Block
Code Block
{
    "access_token": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyMDAxZDFlZS1jOWUxLTRhMDctOTZkNi1hNTMyNGEzMjczY2UiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODk2OSwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY5NTY5LCJhdWQiOiJjbWEtdXNlcnMifQ.v2Tbnw4bKuQSMAjtj36eVjrcMoE1vH93C6axpN9Y4wE",
    "accessTokenExpiresDateTime": "2022-04-27T14:26:09.3528117+00:00",
    "refresh_token": "886be8d80a65477b8ce9b4b643fe6994",
    "refreshTokenExpiresDateTime": "2022-04-28T14:16:09.3528117+00:00"
}
Expand
titleResponse (status 401)

Returned if the Consumer or SecretKey are incorrect or missing.

Expand
titleResponse (status 404)

Returned if refresh tolekn is not found

Delete authentication tokens

For deleting of authentication tokens you need to send following request:

Expand
titleDELETE https://<base-url>/DeleteToken?refreshToken=6ed6d7ba271d43a0843f8f363fe27279

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED
SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

Expand
titleResponse (status 200)
Code Block
true
Expand
titleResponse (status 401)

Returned if the Consumer or SecretKey are incorrect or missing.

Expand
titleResponse (status 404)

Returned if refresh tolekn is not found

Applications

Returns list of all third-part applications supported by CMA

Expand
titleGET https://<base-url>/Applications

Headers:

Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyMDAxZDFlZS1jOWUxLTRhMDctOTZkNi1hNTMyNGEzMjczY2UiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODk2OSwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY5NTY5LCJhdWQiOiJjbWEtdXNlcnMifQ.v2Tbnw4bKuQSMAjtj36eVjrcMoE1vH93C6axpN9Y4wE

languagejson
[
    {
        "name": "GetMetaData",
        "parameters": "",
        "verb": "GET",
        "authenticate": false,
        "description": "Returns controllers actions",
        "returns": "JSON array"
    },
    {
        "name": "Describe",
        "parameters": "String name",
        "verb": "GET",
        "authenticate": false,
        "description": "Describes object properties",
        "returns": ""
    },
    {
        "name": "Authenticate",
        "parameters": "",
        "verb": "GET",
        "authenticate": false,
        "description": "Checks authentification",
        "returns": "boolean"
    },
    {
        "name": "Applications",
        "parameters": "",
        "verb": "GET",
        "
tag
authenticate":
"Accounting"
false,
        "
sessionTimeMins
description":
0
 "Returns Canvas applications",
        "
sessionSlidingExpiry
returns":
false
"JSON Array"
    },
    {
        "
id
name": "
97cbc3b3-32c7-4e4a-b788-a332ea82aeff
WorkflowTemplates",
        "parameters": "",
        "
name
verb": "
Quinyx
GET",
        "
shortName
authenticate":
"QUIN"
false,
        "description": "
Workforce planning
Returns list of workflow templates",
        "
vendorUrl
returns": "
http://www.quinyx.com", 
JSON array"
    },
    {
"credentialFields":
"[\r\n
{\r\n
\
"
ShortName\
name":
\
"
apikey\
Accounts",
\r\n
\
"
Name\
parameters":
\
"
API key\
",
\r\n
\
"
Type\
verb":
\
"
text\
GET",
\r\n
\"Value\":
\"\",\r\n
\
"
Optional\
authenticate": false,
\r\n
\
"
Desc\
description":
\"Your Quinyx API key\",\r\n
"Returns list of accounts in the organization",
\
"
Hidden\
returns":
false\r\n
"JSON array"
    },
\r\n

    {
\r\n
\
"
ShortName\
name":
\
"
environment\
RegApplications",
\r\n
\
"
Name\
parameters":
\
"
Environment\
",
\r\n
\
"
Type\
verb":
\
"
select\
GET",
\r\n
\
"
Value\
authenticate":
\"\",\r\n
false,
\
"
Options\
description":
\"live|Live Environment,test|Test Environment\",\r\n
"Returns account registerred applications",
\
"
Optional\
returns":
false,\r\n
"JSON Array"
    },
    {
\
"
Desc\
name":
\
"Workflows"
Choose
,
which
Quinyx
environment
you
wish
to
use,
live
or test.\",\r\n
"parameters": "",
\
"
Hidden\
verb":
false\r\n }\r\n]
"GET",
        "
tag
authenticate":
"Scheduling,Planning,Premium"
false,
        "
sessionTimeMins
description":
0
"Returns list of registered workflows",
        "
sessionSlidingExpiry
returns": "JSON
false
array"
    },
    {
        "
id
name": "
5fb75b88-4ef3-4803-83f9-a87d83f97d27
Workflow",
        "
name
parameters": "
Procountor
Guid id",
        "
shortName
verb": "
PROC
GET",
        "
description
authenticate":
"Accounting"
false,
        "
vendorUrl
description": "
https://finago.com/
Returns registered workflow by id",
        "
credentialFields
returns": "
[\r\n {\r\n \"ShortName\": \"apikey\",\r\n
JSON"
    },
    {
\
"
Name\
name":
\
"
API key\
RegApplication",
\r\n
\
"
Type\
parameters":
\"text\",\r\n
"[FromBody]AddRegApplicationApiDto regApp",
\
"
Value\
verb":
\
"
\
POST",
\r\n
\
"
Optional\
authenticate": false,
\r\n
\
"
Desc\
description":
\
"
Your
Registers
Quinyx
a
API key.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n
new application and returns Id",
\
"
ShortName\
returns":
\
"
environment\",\r\n
Guid"
\"Name\": \"Environment\",\r\n
 },
    {
\"Type\": \"select\",\r\n
\
"
Value\
name":
\
"
\
Workflow",
\r\n
\
"
Options\
parameters":
\"live|Live environment,test|Test environment\",\r\n
"[FromBody]AddWorkflowApiDto workflow",
\"Optional\":
false,\r\n
\
"
Desc\
verb":
\
"POST"
Choose
,
which
Quinyx
environment you
wish
to
use,
live
or
test.\",\r\n \"Hidden\": false\r\n }\r\n]"
"authenticate": false,
        "
tag
description": "
Accounting",
Registers a new workflow based on template and returns Id"
sessionTimeMins": 50
,
        "
sessionSlidingExpiry
returns":
true
"Guid"
    },
    {
        "
id
name": "DeleteWorkflow",
        "parameters": "
46ee5fc6-e79f-4577-add5-a900beb1202f
Guid id",
        "
name
verb": "
DNB Factoring
GET",
        "
shortName
authenticate":
"DNBB"
false,
        "description": "
Invoicing
Deletes workflow by Id",
        "
vendorUrl
returns": "
http://www.dnb.no",
Guid"
    },
"credentialFields":
"[\r\n 
{
\r\n
\"ShortName\":
\"activationcode\",\r\n
\
"
Name\
name":
\
"
Activation code\
RunWorkflow",
\r\n
\"Type\":
\"text\",\r\n
\
"
Value\
parameters":
\"\
"[FromBody]RunMetadataApiDto metadata",
\r\n
\"Optional\":
false,\r\n
\
"
Desc\
verb":
\"Your ConnectMyApps activation code.\",\r\n
"POST",
\
"
Hidden\
authenticate": false
\r\n
,
},\r\n
{\r\n
\
"
ShortName\
description":
\
"
customerid\",\r\n
Runs workflow",
\
"
Name\
returns":
\"DNB customer ID\",\r\n
"Guid"
    },
    {
\"Type\":
\"text\",\r\n
\
"
Value\
name":
\
"
\
WorkflowScheduler",
\r\n
\"Optional\":
false,\r\n
\
"
Desc\
parameters":
\"Your DNB customer ID\",\r\n
"[FromBody]UpdateWorkfowSchedulerApiDto scheduler",
\
"
Hidden\
verb":
false\r\n }\r\n]
"POST",
        "
tag
authenticate":
"Banking
false,
Invoicing",

        "
sessionTimeMins
description":
0
"Updates the workflow scheduler",
        "
sessionSlidingExpiry
returns":
false
""
    },
    {
        "
id
name":
"ef2b25d4-15ac-4f29-8e29-b0e7b55ceffd
"Account",
        "
name
parameters": "
Netset
[FromBody]AddAccountApiDto data",
        "
shortName
verb": "
NETS
POST",
        "
description
authenticate":
"E-commerce"
false,
        "
vendorUrl
description": "
http://www.netset.se
Account registration",
        "
credentialFields
returns": "
[\r\n {\r\n
"
    }
]

Describe

For getting of description about APIs parameters you can use following request:

Expand
titleGET https://<base-url>/Describe?name=AddWorkflowApiDto

Header:

no header

Expand
titleResponse (status 200)
Code Block
languagejson
[
    {
\
"
ShortName\
typeName":
\
"
domain\
guid",
\r\n
\"Name\":
\"Domain\",\r\n
\
"
Type\
propertyName":
\
"
text\
workflowTemplateId",
\r\n
\
"
Value\
genericParameters":
\
"
\
",
\r\n
\"Optional\":
false,\r\n
\
"
Desc\
isRequired":
\"The url to the root folder of your ftp. The url must be entered without ftp prefix e.g. myshop.demo.com\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"username\",\r\n \"Name\": \"User name\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"FTP user name\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"password\",\r\n \"Name\": \"Password\",\r\n \"Type\": \"password\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"FTP password\",\r\n \"Hidden\": false\r\n }\r\n]", "tag": "E-Commerce,Premium
true
    },
    {
        "typeName": "string",
        "propertyName": "name",
        "genericParameters": "",
        "isRequired": false
    },
    {
        "typeName": "string",
        "propertyName": "description",
        "genericParameters": "",
        "isRequired": false
    },
    {
        "typeName": "dictionary",
        "propertyName": "applications",
        "genericParameters": "string,guid",
        "isRequired": true
    },
    {
        "typeName": "iEnumerable",
        "
sessionTimeMins
propertyName":
0
"chain",
        "
sessionSlidingExpiry
genericParameters":
false
"chainApiDto",
},
    "isRequired":
{
false
"id": "eccdaf34-54b2-47d8-a0a5-b1222d60066d",
}
]

APIs for organization administration

Accounts

Returns list of all active accounts in your organization

Expand
titleGET https://<base-url>/Accounts

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED

SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

ManagedAccountId:a4ba9a9b-ce81-4f06-81c6-032bf7d648f5

Info

ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access

Expand
titleResponse (status 200)
Code Block
languagejson
[
    {
        "
name
id": "
Sympa HR
41a31538-1120-4bdf-a6cb-675eeedd7d2d",
        "
shortName
firstName": "
SYMP
Nathan",
        "
description
lastName": "
Human Resources
Bray",
        "
vendorUrl
email": "
http://www.sympa.no
nathan.bray@connectmyapps.com",
        "
credentialFields
organizationId": "
[\r\n {\r\n \"ShortName\": \"apiKey\",\r\n
00000000-0000-0000-0000-000000000000",
\
"
Name\
organizationName":
\
"
API key\
CMA Customer Bench",
\r\n
\"Type\":
\"text\",\r\n
\
"
Value\
roleId":
\"\",\r\n
"349889ad-4277-42d0-a268-5cd27230cfc5",
\"Optional\":
false,\r\n
\
"
Desc\
role":
\"Your API key.\",\r\n
"User",
\
"
Hidden\
dateCreated":
false\r\n
 "2020-05-07T19:10:36.69"
    },
\r\n

    {
\r\n
\
"
ShortName\
id":
\"apiSecret\",\r\n
"18cc3b9f-c14e-4c7d-892b-7cc5545abac0",
\
"
Name\
firstName":
\
"
API secret\
Igor",
\r\n
\
"
Type\
lastName":
\
"
text\
Kostian",
\r\n
\
"
Value\
email":
\
"
\
igor.kostian@connectmyapps.com",
\r\n
\"Optional\":
true,\r\n
\
"
Desc\
organizationId":
\"Your API secret.\",\r\n
"00000000-0000-0000-0000-000000000001",
\
"
Hidden\
organizationName":
false\r\n }\r\n]
"ConnectMyApps AS",
        "
tag
roleId": "
HR
9c525665-df99-4aee-9e52-1a55853db03b",
        "
sessionTimeMins
role":
0
"Admin",
        "
sessionSlidingExpiry
dateCreated":
false
"2017-03-01T08:51:32.31"
    },
    {
        "id": "
9c8d7f67
a305c3a2-
b538
cba5-
41fd
4554-
8275
bb5d-
b35e1e7e85cf
ab7fcd5b4a4c",
        "
name
firstName": "
Fort Nox
Luke",
        "
shortName
lastName": "
FORT
Buckley",
        "
description
email":
"Accounting and Invoicing
"luke.buckley@connectmyapps.com",
        "organizationId": "00000000-0000-0000-0000-000000000000",
        "
vendorUrl
organizationName": "
https://www.fortnox.se/
CMA Customer Bench",
        "
credentialFields
roleId": "
[\r\n {\r\n
9c525665-df99-4aee-9e52-1a55853db03b",
\
"
ShortName\
role":
\
"
authCode\
Admin",
\r\n
\
"
Name\
dateCreated":
\"Access token\",\r\n
"2013-06-01T18:56:22.763"
\"Type\": \"text\",\r\n
}
]

Account

Registers a new account and returns account Id. If account is created as inactive then an email to complete activation will be send by corresponded address.

Expand
titlePOST https://<base-url>/Account

Body JSON structure:

AddAccountApiDto

Body example:

Code Block
languagejson
{
\
"
Value\
firstName":
\
"
\
John",
\r\n
\
"
Optional\
lastName":
false,\r\n
"Smeet",
\
"
Desc\
email":
\"Your Fort Nox access token\",\r\n
"john.smmet@сompany.com",
\
"
Hidden\": false\r\n }\r\n]
phone":"+470568765432",
    "roleName":"SuperPartner",
    "
tag
countryKey":
"
Fort Nox accounting
DE",
    "globalNotifications":true,
    "
sessionTimeMins
defaultNotificationEmail":
0
"support@connectmyapps.com",    
    "
sessionSlidingExpiry
activated":
false }, { "id": "9a6244f4-c20c-43d1-804f-bb0f5b924a68", "name": "Younium",
true
}

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED

SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

ManagedAccountId:a4ba9a9b-ce81-4f06-81c6-032bf7d648f5

Info

ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access

Expand
titleResponse (status 200)
Code Block
languagejson
"296dce4a-3e24-495e-833c-e183ccfbf2d9"
Expand
titleResponse (status 401)

Status Code: 401; Unauthorized

Expand
titleResponse (status 400)
Code Block
Account has already been created
Expand
titleResponse (status 400)
Code Block
Role Admin is not supported. Please use SuperPartner or User

Application APIs

Applications

Returns list of all third-part applications supported by CMA

Expand
titleGET https://<base-url>/Applications

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED

SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

ManagedAccountId:a4ba9a9b-ce81-4f06-81c6-032bf7d648f5

Info

ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access

Expand
titleResponse (status 200)
Code Block
languagejson
[
    {
        "
shortName
id": "
YOUN
07ffd13d-ba57-4d1b-9c46-03c5c919eed0",
        "
description
name": "
B2B Subscription Managment
Talentsoft",
        "
vendorUrl
shortName":
null
"TASO",
        "
credentialFields
description": "
[\r\n {\r\n
HR",
\
"
ShortName\
vendorUrl":
\"username\",\r\n \"Name\": \"User name\",\r\n
"https://www.talentsoft.com/",
\
"
Type\
credentialFields":
\"text\",\r\n
[
\"Value\":
\"\",\r\n
\"Optional\":
false,\r\n
   {
\"Desc\":
\"Your
user
name\",\r\n
\"Hidden\":
false\r\n
},\r\n
{\r\n
\
"ShortName
\
":
\
"
password\
baseUrl",
\r\n
\"Name\":
\"Password\",\r\n
\
"
Type\
Name":
\
"
password\
Base url",
\r\n
\"Value\":
\"\",\r\n
\"Optional\":
false,\r\n
\
"
Desc\
Type":
\
"
Your password\
text",
\r\n
\"Hidden\":
false\r\n
},\r\n
{\r\n
\"ShortName\":
\"webhookid\",\r\n
\
"
Name\
Value":
\
""
CMA
,
Webhook
RegistrationId\",\r\n
\"Type\":
\"text\",\r\n
\"Value\":
\"\",\r\n
\
"Optional
\
":
true,\r\n
false,
\
"Desc
\
":
\
"
CMA
Talentsoft
Webhook
API
RegistrationId\",\r\n
url.",
\
"Hidden
\
": false
\r\n

            },
\r\n {\r\n

            {
\
"ShortName
\
":
\
"
webhooksecret\",\r\n
client_id",
\
"Name
\
":
\
"
CMA Webhook PrivateKey\",\r\n
Client ID",
\
"Type
\
":
\
"
password\",\r\n
text",
\
"Value
\
":
\
"
\
",
\r\n
\
"Optional
\
":
true,\r\n
false,
\
"Desc
\
":
\
"
CMA
Talentsoft
Webhook
client
PrivateKey\",\r\n
ID.",
\
"Hidden
\
": false
\r\n

            },
\r\n {\r\n \"ShortName\": \"environment\",\r\n

            {
\"Name\":
\"Environment\",\r\n
\"Type\":
\"select\",\r\n
\
"
Value\
ShortName":
\
"
\
client_secret",
\r\n
\"Options\":
\"live|Live
environment,sandbox|Sandbox
environment\",\r\n
\"Optional\":
false,\r\n
\
"
Desc\
Name":
\"Choose which Younium environment you wish to use, live or sandbox.\",\r\n
"Client secret",
\
"
Hidden\
Type":
false\r\n }\r\n]",
 "text",
                "
tag
Value": "
Accounting; Finance; Subscription Managment
",
"sessionTimeMins":
0,
       
"
sessionSlidingExpiry
Optional": false,
},
{
       
"
id
Desc": "
0654a77c-6102-481f-bc19-c11bff684326", 
Talentsoft client secret.",
"name":
"Adra",
         "
shortName
Hidden":
"ADRA",
false
"description":
"Financial
Management",
 }
"vendorUrl": "https://www.trintech.com/adra/"
 ],
        "
credentialFields
credentialsJson":
"[\r\n 
{
\r\n
\"ShortName\": \"token\",\r\n
\"Name\":
\"Token\",\r\n
\
"
Type\
baseUrl":
\"text\",\r\n
null,
\"Value\":
\"\",\r\n
\"Optional\":
false,\r\n
\"Desc\
"client_id":
\"Token\",\r\n
null,
\"Hidden\":
false\r\n
},\r\n
{\r\n
\
"
ShortName\
client_secret":
\"platform\",\r\n
 null
\"Name\":
\"Adra platform\",\r\n
 },
\
"
Type\
tag":
\"select\
"Hr, Premium",
\r\n
\"Value\":
\"\",\r\n
\
"
Options\
sessionTimeMins": 0,
\"balancer
and
matcher|Balancer
&
Matcher,balancer|Balancer,matcher|Matcher\",\r\n
\
"
Optional\
sessionSlidingExpiry": false
,\r\n

    },
\"Desc\": \"Choose which AdraAdra platform you use\",\r\n
 {
\
"
Hidden\
id":
false\r\n },\r\n {\r\n
 "97cbc3b3-32c7-4e4a-b788-a332ea82aeff",
\
"
ShortName\
name":
\
"
environment\
Quinyx",
\r\n
\
"
Name\
shortName":
\
"
Environment\
QUIN",
\r\n
\
"
Type\
description":
\
"
select\
Workforce planning",
\r\n
\"Value\":
\"\",\r\n
\
"
Options\
vendorUrl":
\"live|Live Environment,test|Test Environment\",\r\n
"http://www.quinyx.com",
\"Optional\":
false,\r\n
\
"
Desc\
credentialFields":
\"Choose which Adra environment you wish to use, live or test.\",\r\n
[
            {
\"Hidden\":
false\r\n
}\r\n]",
          "
tag
ShortName": "
Adra API
apikey",
"sessionTimeMins": 0, 
        "
sessionSlidingExpiry
Name":
false
"API key",
},
{
        
"
id
Type": "
c1279108-28c3-4b58-9407-cca6a949322e
text",
"name
        "Value": "
ALSO
",
"shortName
        "Optional":
"ALSO",
false,
                "
description
Desc": "
B2B
Your Quinyx API key",
                "
vendorUrl
Hidden":
"https://nordic.also.com/",
 false
            },
"credentialFields":
"[\r\n
  {
\r\n
\"ShortName\":
\"user\",\r\n
\"Name\":
\"User email\",\r\n
\
"
Type\
ShortName":
\
"
text\",\r\n
environment",
\
"
Value\
Name":
\
"
\
Environment",
\r\n
\"Optional\":
false,\r\n
\
"
Desc\
Type":
\
"select"
Your
,
ALSO
user
email.\",\r\n
\"Hidden\":
false\r\n
},\r\n
{\r\n
\
"
ShortName\
Value":
\
"
password\",\r\n
",
\
"
Name\
Options":
\"Password\",\r\n
"live|Live Environment,test|Test Environment",
\"Type\": \"password\",\r\n
\"Value\":
\"\",\r\n
\
"Optional
\
": false,
\r\n
\
"Desc
\
":
\"Your ALSO password.\",\r\n
"Choose which Quinyx environment you wish to use, live or test.",
\
"Hidden
\
": false
\r\n

            }
,\r\n
{\r\n
\"ShortName\":
\"url\",\r\n
  ],
\"Name\":
\"Market
place
name\",\r\n
\
"
Type\
credentialsJson":
\"text\",\r\n
 {
\"Value\": \"\",\r\n
\
"
Optional\
apikey":
true
null,
\r\n
\"Desc\":
\"Your
ALSO
market
place
name.\",\r\n
\
"
Hidden\
environment":
true\r\n
null
        }
\r\n]"
,
        "tag": "
B2B Marketplace
Scheduling,Planning,Premium",
        "sessionTimeMins":
10
0,
        "sessionSlidingExpiry":
true
false
    },
	...,
    {
        "id": "
cec65fa8
b5a4a9ed-
faa1
a686-
4654
4b1e-
a361
af30-
d08c366e2d02
ffd84b7fb2e0",
        "name": "
Canvas
Talent Manager",
        "shortName": "
CANV
HRTM",
        "description": "
CMA
HR
Canvas
solution",
        "vendorUrl": "
https
http://
connectmyapps.com
www.hr-manager.net",
        "credentialFields":
"[\r\n
[
            {
\r\n
\"ShortName\":
\"consumerkey\",\r\n
\"Name\":
\"Consumer Key\",\r\n
\
"
Type\
ShortName":
\
"
text\",\r\n
customeralias",
\
"
Value\
Name":
\
"
\",\r\n
Customer alias",
\"Optional\":
false,\r\n
\
"
Desc\
Type":
\
"text"
Your
,
CANVAS
Consumer
Key\",\r\n
\"Hidden\":
false\r\n
},\r\n
{\r\n
\
"
ShortName\
Value":
\
"
secretkey\
",
\r\n
\"Name\":
\"Secret
Key\",\r\n
\
"
Type\
Optional":
\"text\",\r\n
false,
\"Value\": \"\",\r\n
\"Optional\":
false,\r\n
\
"Desc
\
":
\
"Your
CANVAS Secret Key\",\r\n
customer alias.",
\
"Hidden
\
": false
\r\n

            },
\r\n

            {
\r\n
\"ShortName\":
\"environment\",\r\n
\"Name\":
\"Environment\",\r\n
\
"
Type\
ShortName":
\
"
select\
apikey",
\r\n
\"Value\":
\"\",\r\n
\"Options\":
\"live|Live
Environment,test|Test
Environment\",\r\n
\
"
Optional\
Name":
false,\r\n
"Your API key",
\"Desc\":
\"Choose
which
Canvas
environment
you
wish
to
use,
live
or test.\",\r\n
"Type": "text",
\"Hidden\":
false\r\n
}\r\n]",
         "
tag
Value": "
CMA Canvas
",
                "
sessionTimeMins
Optional":
5
false,
"sessionSlidingExpiry
        "Desc":
true
"Your API key.",
},
{
         "
id
Hidden":
"e2ed3968-1489-4739-9659-d108ac942b7a", 
false
            }
"name": "Tripletex"
 ],
        "
shortName
credentialsJson":
"TRIP2",
 {
            "
description
customeralias":
"Accounting",
null,
            "
vendorUrl
apikey":
"https://www.tripletex.no/",
 null
        },
"credentialFields":
"[\r\n
{\r\n
\
"
ShortName\
tag":
\
"
employeeToken\
HR",
\r\n
\"Name\":
\"Employee
token\",\r\n
\
"
Type\
sessionTimeMins":
\"text\",\r\n
0,
\"Value\":
\"\",\r\n
\
"
Optional\
sessionSlidingExpiry": false
,\r\n
\"Desc\": \"Your employee token\",\r\n \"Hidden\": false\r\n }\r\n]", 
}
]
Expand
titleResponse (status 401)

Returned if the Authorization is incorrect or missing.

RegApplications

Returns account registerred applications

Expand
titleGET https://<base-url>/RegApplications

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED

SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

ManagedAccountId:a4ba9a9b-ce81-4f06-81c6-032bf7d648f5

Info

ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access

Expand
titleResponse (status 200)
Code Block
languagejson
[
    {
        "
tag
id": "
Tripletex accounting
1710ff47-f590-43db-b0de-015676e99615",
        "
sessionTimeMins
shortName":
50,
"sessionSlidingExpiry": false }, {
"QUIN",
        
"
id
accountId": "
938e3dea
6fa122e4-
559e
0d4c-
4794
4a1d-
a0af
8869-
d1592b04ebfb
7c0a86a37bf1",
        "
name
applicationId": "
REST API
97cbc3b3-32c7-4e4a-b788-a332ea82aeff",
        "
shortName
name": "
REST
Quinyx",
        "
description
tagText": "
REST API
N-Quinyx",
        "
vendorUrl
description": "
https://www.connectmyapps.com
Workforce planning",
        "
credentialFields
isAuthenticated":
"[\r\n
true,
{\r\n
\"ShortName\":
\"url\",\r\n
\
"
Name\
isOAuthApp":
\"Base url\",\r\n
false,
\"Type\":
\"\",\r\n
\
"
Value\
dateModified":
\"\",\r\n
"2022-04-19T15:56:22.1133746",
\"Optional\":
false,\r\n
\
"
Desc\
dateTimeUtcAuthenticated":
\"Base url\",\r\n \"Hidden\": false\r\n },\r\n {\r\n
"2022-04-19T15:56:22.0345429",
\
"
ShortName\
dateTimeForReAuth":
\"secret1\",\r\n
"2022-04-19T15:56:22.0345429",
\"Name\":
\"Secret
1\",\r\n
\
"
Type\
sessionTimeMins":
\"\",\r\n
0,
\"Value\":
\"\",\r\n
\
"
Optional\
sessionSlidingExpiry":
true
false,
\r\n
\"Desc\": \"Secret
1\",\r\n
\
"
Hidden\
faulted": false
\r\n

    },
\r\n

    {
\r\n
\"ShortName\":
\"secret2\",\r\n
\
"
Name\
id":
\"Secret 2\",\r\n
"d2698be7-9f12-44b1-8e6d-0494436538a8",
\
"
Type\
shortName":
\
"
\
MSQL",
\r\n
\
"
Value\
accountId":
\"\",\r\n
"6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
\"Optional\":
true,\r\n
\
"
Desc\
applicationId":
\"Secret 2\",\r\n
"276511d9-f07f-4fa6-b109-fdb4d62b2429",
\
"
Hidden\
name":
false\r\n }\r\n]
"Microsoft SQL On-premise",
        "
tag
tagText": "
REST API, Premium
N-Microsoft SQL On-premise",
        "
sessionTimeMins
description":
0
"Database engine",
        "
sessionSlidingExpiry
isAuthenticated":
false
true,
},
{
"isOAuthApp": false,
        "
id
dateModified": "
f6523796
2021-
b166-45ad-9831-d4a96c1dd326
09-06T13:30:11.2590869",
        "
name
dateTimeUtcAuthenticated": "
Amazon S3
2021-04-14T10:27:22.1672672",
        "
shortName
dateTimeForReAuth": "
AWS3
2021-04-14T10:27:22.1672672",
        "
description
sessionTimeMins":
"File Storage"
0,
        "
vendorUrl
sessionSlidingExpiry":
null
false,
        "
credentialFields
faulted":
"[\r\n
false
{\r\n
  },
\"ShortName\":
\"accessKey\",\r\n
  {
\"Name\":
\"Access
key
ID\",\r\n
\
"
Type\
id":
\"text\",\r\n
"dbdd41cf-28de-4d2d-9771-7105c2165bcf",
\"Value\":
\"\",\r\n
\
"
Optional\
shortName":
false,\r\n
"CMAF",
\"Desc\":
\"Your
AWS
access
key
ID.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n
"accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
\
"
ShortName\
applicationId":
\"secretKey\",\r\n
"9b6a04b3-c91f-4255-9033-6ac7b7a6f935",
\
"
Name\
name":
\
"
Secret access key\",\r\n
File Hub",
\
"
Type\
tagText":
\
"
text\",\r\n
File Hub",
\
"
Value\
description":
\
"
\
File automation",
\r\n
\"Optional\":
false,\r\n
\
"
Desc\
isAuthenticated":
\"Your AWS secure access key.\",\r\n
true,
\
"
Hidden\
isOAuthApp": false
\r\n
,
},\r\n
{\r\n
\
"
ShortName\
dateModified":
\"region\",\r\n
"2022-04-20T14:00:27.1912258",
\"Name\":
\"Region\",\r\n
\
"
Type\
dateTimeUtcAuthenticated":
\"select\",\r\n
null,
\"Value\":
\"\",\r\n
\
"
Options\
dateTimeForReAuth":
\"us-east-2|US East (Ohio),us-east-1|US East (N. Virginia),us-west-1|US West (N. California),us-west-2|US West (Oregon),af-south-1|Africa (Cape Town),ap-east-1|Asia Pacific (Hong Kong),ap-south-1|Asia Pacific (Mumbai),ap-northeast-3|Asia Pacific (Osaka),ap-northeast-2|Asia Pacific (Seoul),ap-southeast-1|Asia Pacific (Singapore),ap-southeast-2|Asia Pacific (Sydney),ap-northeast-1|Asia Pacific (Tokyo),ca-central-1|Canada (Central),cn-north-1|China (Beijing),cn-northwest-1|China (Ningxia),eu-central-1|Europe (Frankfurt),eu-west-1|Europe (Ireland),eu-west-2|Europe (London),eu-south-1|Europe (Milan),eu-west-3|Europe (Paris),eu-north-1|Europe (Stockholm),me-south-1|Middle East (Bahrain),sa-east-1|South America (São Paulo)\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your AWS service region.\",\r\n \"Hidden\": false\r\n }\r\n]
 null,
        "sessionTimeMins": 0,
        "sessionSlidingExpiry": false,
        "faulted": false
    },
    {
        "id": "a067c363-7339-4fed-b1ad-efafd7603986",
        "shortName": "FTP",
        "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "
tag
applicationId": "
Files Storage
5f814909-01ea-4395-96ee-5ba7614128fc",
        "
sessionTimeMins
name": "FTP
0
Server",
        "
sessionSlidingExpiry
tagText":
false
 "N-FTP Server",
},
  "description": "File upload
{
and download",
        "
id
isAuthenticated":
"3d996ebd-cf2c-465b-9720-e06ddf48f23c"
true,
        "
name
isOAuthApp":
"Visma Global"
false,
        "
shortName
dateModified": "
VISG
2022-02-01T15:33:49.9987294",
        "
description
dateTimeUtcAuthenticated": "
ERP and accounting
2022-02-01T15:33:49.9919226",
        "
vendorUrl
dateTimeForReAuth":
null
"2022-02-01T15:33:49.9919226",
        "
credentialFields
sessionTimeMins":
"[\r\n {\r\n
0,
\
"
ShortName\
sessionSlidingExpiry":
\"username\",\r\n
false,
\
"
Name\
faulted": false
\"User
name\",\r\n
\"Type\": \"text\",\r\n
},
]

RegApplication

Registers a new application and returns Id

Expand
titlePOST https://<base-url>/RegApplication

Body JSON structure:

AddRegApplicationApiDto

Body example 1:

Code Block
languagejson
{
\
"
Value\
applicationId":
\"\",\r\n
"97cbc3b3-32c7-4e4a-b788-a332ea82aeff",
\
"
Optional\
tagText":
false,\r\n
"Quinyx 2022-04-28",
    "credentialsJson": "{\"
Desc
apikey\":
\"Your Visma Global user name.\",\r\n \"Hidden
\"01d6-3e54-cff2-c7d8\",\"environment\":
false
\
r\n },\r\n {\r\n
"test\"}"
}

Body example 2:

Code Block
languagejson
{
\
"
ShortName\
applicationId":
\"password\",\r\n
"5f814909-01ea-4395-96ee-5ba7614128fc",
\
"
Name\
tagText":
\"Password\",\r\n
"FTP 2022-05-03",
\
"
Type\
credentialsJson": "{\"
password
username\": null,\
r\n \"Value
"password\": null,\"port\": null,\"address\": null,\
r
"secure\
n
":
\"Optional\": false,\r\n \"Desc\": \"Your Visma Global user password.\",\r\n \"Hidden\": false\r\n },\r\n {\r\n \"ShortName\": \"companyname\",\r\n \"Name\": \"Company name\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Visma Global company name.\",\r\n \"Hidden\": true\r\n },\r\n {\r\n \"ShortName\": \"apikey\",\r\n \"Name\": \"API key\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your Visma Global API key.\",\r\n \"Hidden\": true\r\n },\r\n {\r\n \"ShortName\": \"connectorkey\",\r\n \"Name\": \"CloudConnector key\",\r\n \"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your CloudConnector key.\",\r\n \"Hidden\": true\r\n }\r\n]",
true}"
}

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED

SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

ManagedAccountId:a4ba9a9b-ce81-4f06-81c6-032bf7d648f5

Info

ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access

Expand
titleResponse (status 200)
Code Block
languagejson
"eea37d64-5a93-478c-8216-6231c0a37f0a"
Expand
titleResponse (status 401)

Status Code: 401; Unauthorized

Expand
titleResponse (status 400)
Code Block
Authentication Error: You must enter a value for User name.
You must enter a value for Password.
You must enter a value for Port.
You must enter a value for Server address.

Workflow APIs

WorkflowTemplates

Returns list of workflow templates provided by CMA and your organization

Expand
titleGET https://<base-url>/WorkflowTemplates

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED

SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

ManagedAccountId:a4ba9a9b-ce81-4f06-81c6-032bf7d648f5

Info

ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access

Expand
titleResponse (status 200)
Code Block
languagejson
[
    {
        "id": "bbe52876-aca2-4ece-ba31-11e0d98ddc19",
        "name": "Quinyx Employee Export Into FTP(CSV)",
        "description": "Quinyx Employee Export Into FTP(CSV)",
        "dateCreated": "2020-08-14T17:12:29.7856246",
        "dateModified": "2022-03-17T13:54:07.0394189",
        "state": "Published",
        "version": "0.1.7",
        "draftIsCommitted": false,
        "dateCommitted": "2021-02-26T16:51:29.3588575",
        "organizationId": null,
        "applications": [
            "QUIN",
            "
tag": "ERP, Accounting,Premium",
FTP"
        ],
        "
sessionTimeMins
chain":
0,
[
"sessionSlidingExpiry":
false
  {
},
{
         "
id
uniqueBlockId": "
9117a096
02d1424a-
123a
da90-
4506
4c12-
ba22
9c28-
e547df43aaaf",
96162e624bd7",
                "
name
blockName": "
Unleashed
API - Get Employees",
                "
shortName
variables":
"UNLE",
 {
"description":
"Logistics",
         "
vendorUrl
apiKeys":
"http://www.unleashedsoftware.com"
[],
"credentialFields": "[\r\n {\r\n
\
"
ShortName\
badgeNo":
\"apiId\",\r\n
 null
\"Name\":
\"API
ID\",\r\n
\"Type\":
\"text\",\r\n
\"Value\": \"\",\r\n
 }
\"Optional\":
false,\r\n
\"Desc\":
\"Your
Unleashed
API
ID.\",\r\n
},
\"Hidden\":
false\r\n
},\r\n
  {
\r\n
\"ShortName\":
\"apiKey\",\r\n
\"Name\":
\"API
key\",\r\n
\
"
Type\
uniqueBlockId":
\"text\",\r\n
"25782580-aabe-4a03-be1c-bc45dacd7e60",
\"Value\":
\"\",\r\n
\"Optional\":
false,\r\n
\
"
Desc\
blockName":
\
"
Your Unleashed API key.\",\r\n
FTP Upload",
\"Hidden\":
false\r\n
}\r\n]",
         "
tag
variables":
"Inventory",
 {
"sessionTimeMins":
0,
         "
sessionSlidingExpiry
filename":
false
 "NY_Employees_{date:yyyy-MM-dd-HH-mm}",
},
{
         "
id
fileformat": "
860e4f73-513f-4cd0-bfd9-e54d2773dcb7
csv",
"name": "Harvest",
            "
shortName
filepath": "
HARV
/"
,
"description":
"Time
registration",
      }
"vendorUrl":
"http://getharvest.com",
"credentialFields": "[\r\n {\r\n
}
\"ShortName\":
\"accountId\",\r\n 
 ]
\"Name\":
\"Account ID\",\r\n
 },
    {
\"Type\":
\"text\",\r\n
\
"
Value\
id":
\"\",\r\n
"3b76ca61-bca9-4995-90ba-7190c1dd567b",
\"Optional\":
false,\r\n
\
"
Desc\
name":
\
"
Your
MyStore Customers
account
Send
id.\
email",
\r\n
\
"
Hidden\
description":
false\r\n },\r\n {\r\n
"MyStore Customers Send email",
\
"
ShortName\
dateCreated":
\"authToken\",\r\n
"2021-11-08T11:39:58.814",
\
"
Name\
dateModified":
\"Harvest authorization token\",\r\n
"2021-11-09T15:14:14.836809",
\
"
Type\
state":
\
"
text\
Published",
\r\n
\
"
Value\
version":
\
"
\
0.0.7",
\r\n
\"Optional\":
false,\r\n
\
"
Desc\
draftIsCommitted":
\"Your Harvest authorization token.\",\r\n
true,
\
"
Hidden\
dateCommitted":
false\r\n }\r\n]
"2021-11-09T15:14:18.6103605",
        "
tag
organizationId":
"Time"
null,
        "
sessionTimeMins
applications":
0,
 [
            "
sessionSlidingExpiry
MYST2"
:
,
false
},
{
 "CMAF"
"id": "96898de9-ec1e-43ab-b805-ecaf2e5c25c6"
 ],
        "
name
chain":
"SameSystem",
 [
            {
"shortName":
"SAME",
         "
description
uniqueBlockId": "
REST API
729e4eb5-8022-43bb-b75b-524b1cb5f5b5",
"vendorUrl
       "blockName": "
https://www.samesystem.com/",
MyStore Get Customers",
                "
credentialFields
variables":
"[\r\n
{}
{\r\n
\"ShortName\":
\"username\",\r\n
\"Name\":
\"User name\",\r\n
 },
\"Type\":
\"text\",\r\n
\"Value\": \"\",\r\n
 {
\"Optional\":
false,\r\n
\"Desc\":
\"Your
SameSystem
user
name.\",\r\n
\
"
Hidden\
uniqueBlockId":
false\r\n },\r\n {\r\n
"a510ddbf-2350-4ab6-9014-c81d0aa3f013",
\"ShortName\": \"password\",\r\n
\
"
Name\
blockName":
\
"
Password\
Send email",
\r\n
\"Type\":
\"password\",\r\n
\"Value\":
\"\",\r\n
\
"
Optional\
variables":
false,\r\n
{
\"Desc\":
\"Your
SameSystem
password.\",\r\n
\"Hidden\":
false\r\n
},\r\n
{\r\n
\
"
ShortName\
subject":
\
"
environment\",\r\n
MyStore Customers",
\
"
Name\
fileName":
\
"
Environment\",\r\n
AllCustomers",
\
"
Type\
note":
\"select\",\r\n \"Value\": \"\",\r\n
"Please see your customers in MyStore"
\"Options\":
\"in|Production,staging1|Staging
1,staging2|Staging
2\",\r\n
\"Optional\":
false,\r\n
  }
\"Desc\":
\"Your
SameSystem
environment
type.\",\r\n
\"Hidden\":
false\r\n
  }
\r\n]"

        ]
    },
    {
        "
tag
id": "
Workforce Management
018fda95-a62f-4f0b-af12-3cfcd9146def",
        "
sessionTimeMins
name":
50
 "Transferring of Orders & Customers",
        "
sessionSlidingExpiry
description":
true
"Transferring of Orders &
}, {
Customers",
        "
id
dateCreated": "
bddf0949
2020-
f75a-4659-8ac1-ecc7ea465c20
08-14T17:22:57.2244016",
        "
name
dateModified": "
Xledger GraphQL
2020-12-10T13:02:23.1685229",
        "
shortName
state": "
XLGQ
Draft",
        "
description
version":
"ERP and accounting"
null,
        "
vendorUrl
draftIsCommitted":
"http://www.xledger.no"
null,
        "
credentialFields
dateCommitted":
"[\r\n {\r\n
 null,
\
"
ShortName\
organizationId":
\"token\",\r\n
null,
\"Name\":
\"Token\",\r\n
\
"
Type\
applications":
\"token\",\r\n
[
\"Value\": \"\",\r\n
\"Optional\":
false,\r\n
\"Desc\":
\
"
GraphQl token\
MYST2",
\r\n
\"Hidden\":
false\r\n
},\r\n
{\r\n
\
"
ShortName\": \"environment\",\r\n
FIKE"
\"Name\": \"Environment\",\r\n
 ],
\"Type\":
\"select\",\r\n
\
"
Value\
chain":
\"\",\r\n
 [
\"Options\":
\"live
|Live
Environment,test|Test
Environment,demo|Demo
Environment\",\r\n
   {
\"Optional\":
false,\r\n
\"Desc\":
\"Choose
which
Xledger
environment
you
wish
to
use,
live
demo
or test.\",\r\n
"uniqueBlockId": "a43e433d-9def-4062-9e89-6ff01824f980",
\"Hidden\":
false\r\n
}\r\n]",
         "
tag
blockName": "
HR,Premium
MyStore Get orders",
"sessionTimeMins":
0,
        
"
sessionSlidingExpiry
variables": {
false
},
{
         "
id
status": "
7919f685-cb62-4e1e-a672-ed2b7a259624
2",
"name":
"Visma
Lønn",
         "
shortName
age":
"VISL",
 null
                }
"description":
"Payroll",
"vendorUrl": "http://www.visma.no"
 },
"credentialFields": "[\r\n
    {
\r\n
\"ShortName\": \"username\",\r\n
\"Name\":
\"User
name\",\r\n
\
"
Type\
uniqueBlockId":
\"text\",\r\n
"d362db53-c46f-4cf8-8bee-9a105ecde130",
\"Value\":
\"\",\r\n
\"Optional\":
false,\r\n
\
"
Desc\
blockName":
\"Your Visma Lønn user name.\",\r\n
 "Get all contacts",
\"Hidden\":
false\r\n
},\r\n
{\r\n
\
"
ShortName\
variables":
\"password\",\r\n
{
\"Name\":
\"Password\",\r\n
\"Type\": \"password\",\r\n
\
"
Value\
testValue":
\
"
\",\r\n
name"
\"Optional\":
false,\r\n
   }
\"Desc\":
\"Your
Visma
Lønn
user
password.\",\r\n
\"Hidden\":
false\r\n
  },
\r\n

            {
\r\n
\"ShortName\":
\"companyname\",\r\n
\"Name\":
\"Company
name\",\r\n
\
"
Type\
uniqueBlockId":
\"text\",\r\n
"6cf1b697-4145-4659-985c-4c9b76a57710",
\"Value\":
\"\",\r\n
\"Optional\":
false,\r\n
\
"
Desc\
blockName":
\
"
Your
Post
Visma
orders
Lønn company name.\",\r\n
& customers",
\
"
Hidden\
variables":
true\r\n
{
},\r\n
{\r\n
\"ShortName\":
\"apikey\",\r\n
\"Name\":
\"API
key\",\r\n
\
"
Type\
shippingtext":
\
"
text\",\r\n
Shipping"
\"Value\":
\"\",\r\n
\"Optional\":
false,\r\n
\"Desc\": \"Your Visma Lønn API key.\",\r\n
 }
\"Hidden\":
true\r\n
},\r\n
{\r\n
}
\"ShortName\":
\"connectorkey\",\r\n
\"Name\": \"CloudConnector key\",\r\n
]
\"Type\": \"text\",\r\n \"Value\": \"\",\r\n \"Optional\": false,\r\n \"Desc\": \"Your CloudConnector key.\",\r\n \"Hidden\": true\r\n }\r\n]
}
]

Workflows

Returns list of registered workflows

Expand
titleGET https://<base-url>/Workflows

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED

SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

ManagedAccountId:a4ba9a9b-ce81-4f06-81c6-032bf7d648f5

Info

ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access

Expand
titleResponse (status 200)
Code Block
languagejson
[
    {
        "id": "ef7a56e6-448f-4787-b58d-47b063d6e983",
        "name": "Quinyx Employee Export Into FTP(CSV)",
        "
tag
description": "
Payroll,Premium
Quinyx Employee Export Into FTP(CSV)",
        "
sessionTimeMins
status":
0
"Ready",
        "
sessionSlidingExpiry
isScheduled": false,
},
    "schedulerFrequency": "{ \"cronSchedule\": \"0 0 * ? * 
*\"
id": "fc4bf0a6-0958-4761-bdbc-efbd75a98ceb"
}",
        "
name
workflowTemplateId":
"Evolution
 "bbe52876-aca2-4ece-ba31-11e0d98ddc19",
        "
shortName
isCustomizedStructure":
"EVOL"
true,
        "
description
accountId": "
Human resource management
6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "
vendorUrl
organizationId": "
http://www.evolution.no
00000000-0000-0000-0000-000000000001",
        "
credentialFields
dateCreated": "
[\r\n {\r\n
2022-02-22T15:29:22.3525209",
\"ShortName\":
\"server\",\r\n
\
"
Name\
dateModified":
\"Server address\",\r\n
"2022-04-13T06:30:56.2625076",
\"Type\":
\"text\",\r\n
\
"
Value\
dateLastRun":
\"\",\r\n \"Optional\": false,\r\n
"2022-04-12T10:35:32.731+00:00",
\
"
Desc\
dateNextSchedule":
\"Your ftp server address.\",\r\n
null,
\
"
Hidden\
regApplicationIds":
false\r\n },\r\n {\r\n
[
\"ShortName\":
\"port\",\r\n
"1710ff47-f590-43db-b0de-015676e99615",
\"Name\":
\"Port
number\",\r\n
\"Type\": \"text\",\r\n
"fa2ee993-03cf-4baf-a8a0-684e92e74ded"
\"Value\": \"\",\r\n
 ],
\"Optional\":
false,\r\n
\
"
Desc\
currentBlock": 5
\"Your
ftp
port
number.\",\r\n
},
\"Hidden\": false\r\n },\r\n {\r\n
{
\
"
ShortName\
id":
\"user\",\r\n
"b459cf22-ad18-44bf-80dc-6e8b78be1cc5",
\
"
Name\
name":
\
"
FTP user name\",\r\n
Order transferring",
\
"
Type\
description":
\"text\",\r\n
"Transfer orders from MyStore into Tripletex invoices with payments",
\
"
Value\
status":
\
"
\
Ready",
\r\n
\
"
Optional\
isScheduled": false,
\r\n

        "schedulerFrequency": "{\"
Desc
cronSchedule\":
\"
Your ftp user name.\",\r\n
0 0 0/1 ? * * *\"}",
\
"
Hidden\
workflowTemplateId":
false\r\n
null,
},\r\n
{\r\n
\
"
ShortName\
isCustomizedStructure":
\"password\",\r\n
false,
\
"
Name\
accountId":
\"Password\",\r\n
"6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
\"Type\":
\"password\",\r\n
\
"
Value\
organizationId":
\"\",\r\n
"00000000-0000-0000-0000-000000000001",
\"Optional\":
false,\r\n
\
"
Desc\
dateCreated":
\"Your ftp password.\",\r\n
"2022-03-24T18:08:22.2543998",
\"Hidden\": false\r\n },\r\n {\r\n
"dateModified": "2022-04-12T10:36:56.478261",
\
"
ShortName\
dateLastRun":
\"folder\",\r\n
"2022-04-12T10:36:57.877+00:00",
\"Name\":
\"FTP
Folder\",\r\n
\
"
Type\
dateNextSchedule":
\"text\",\r\n
"2022-04-05T17:00:00+00:00",
\"Value\":
\"\",\r\n
\
"
Optional\
regApplicationIds":
false,\r\n
 [
\"Desc\":
\"Your
ftp
folder
name.\",\r\n
\"Hidden\": false\r\n }\r\n]",
"281686d9-aedd-4359-89b4-8f878ad43b35",
"tag": "HR,Premium",
 "03548816-f945-4bb2-b66e-950dff826fb8"
"sessionTimeMins": 0
],
        "
sessionSlidingExpiry
currentBlock":
false
3
    },
    {
        "id": "
b05e3f32
a78cee1b-
3e84
adca-
46ce
4777-
a72c
9261-
f4eda963e469
f86e4640e7db",
        "name": "
PowerOffice Go
QuinyxRandom",
        "description": "random",
        "
shortName
status": "
POGO
Ready",
        "
description
isScheduled": true,
        "schedulerFrequency":
"Cloud based accounting
"{\"cronSchedule\":\"0 0 2,6 ? * TUE *\"}",
        "
vendorUrl
workflowTemplateId": null,
        "
https://poweroffice.no/"
isCustomizedStructure": false,
        "
credentialFields
accountId": "
[\r\n {\r\n
6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
\
"
ShortName\
organizationId":
\"clientkey\",\r\n
"00000000-0000-0000-0000-000000000001",
\
"
Name\
dateCreated":
\"Client key\",\r\n
"2021-04-02T08:33:15.3238045",
\
"
Type\
dateModified":
\"text\",\r\n
"2022-04-12T10:19:50.2024988",
\
"
Value\
dateLastRun":
\"\",\r\n
"2022-04-26T06:00:28.976+00:00",
\"Optional\":
false,\r\n
\
"
Desc\
dateNextSchedule":
\"Your PowerOffice Go client key.\",\r\n
"2022-05-03T02:00:00+00:00",
\
"
Hidden\
regApplicationIds":
false\r\n
[
}\r\n]",
"tag":
 "
Accounting",
1710ff47-f590-43db-b0de-015676e99615"
"sessionTimeMins": 0
],
        "
sessionSlidingExpiry
currentBlock":
false
3
    },
    {
        "id": "
10537fe6
4fb07016-
3ba4
6a38-
4f53
4031-
8277
83d7-
f86e5219682c
2cd70af024d9",
        "name": "
24Nettbutikk
BigResponse",
        "
shortName
description": "
T4NB
BigResponse",
        "
description
status": "
E-commerce
Ready",
        "
vendorUrl
isScheduled":
"http://www.24nettbutikk.no"
false,
        "
credentialFields
schedulerFrequency": "
[\r\n 
{
\r\n
 
\"
ShortName
cronSchedule\": \"
apitoken\",\r\n \"Name\": \"API token\",\r\n
0 0 * ? * *\"}",
\"Type\":
\"text\",\r\n
\
"
Value\
workflowTemplateId":
\"\",\r\n
null,
\"Optional\":
false,\r\n
\"Desc\": \"Your API token.\",\r\n \"Hidden\
"isCustomizedStructure": false
\r\n
,
},\r\n
{\r\n
\
"
ShortName\
accountId":
\"domain\",\r\n
"6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
\
"
Name\
organizationId":
\"Web shop domain\",\r\n
"00000000-0000-0000-0000-000000000001",
\"Type\":
\"text\",\r\n
\
"
Value\
dateCreated":
\"\",\r\n
"2021-10-29T14:12:42.4563685",
\"Optional\":
false,\r\n
\
"
Desc\
dateModified":
\"Your web shop domain.\",\r\n
"2022-02-01T09:58:53.506504",
\
"
Hidden\
dateLastRun":
false\r\n }\r\n]
"2021-11-26T16:35:57.573+00:00",
        "
tag
dateNextSchedule":
"Webshop,E-commerce"
null,
        "
sessionTimeMins
regApplicationIds":
0
[],
        "
sessionSlidingExpiry
currentBlock":
false
0
    },
    {
        "id": "
276511d9
8d85eb13-
f07f
9663-
4fa6
4ac7-
b109
8502-
fdb4d62b2429
46c5d38f9c1e",
        "name": "
Microsoft SQL On-premise
SpecialSymbols",
        "
shortName
description": "
MSQL
SpecialSymbols",
        "
description
status": "
Database engine
Ready",
        "
vendorUrl
isScheduled":
"http://www.microsoft.com"
false,
        "
credentialFields
schedulerFrequency": "{ \"
[
cronSchedule\
r\n {\r\n
": \"0 0 * ? * *\"}",
\
"
ShortName\
workflowTemplateId":
\"server\",\r\n
null,
        "isCustomizedStructure": false,
\
"
Name\
accountId":
\"Server name\",\r\n
"6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
\
"
Type\
organizationId":
\"text\",\r\n
"00000000-0000-0000-0000-000000000001",
\
"
Value\
dateCreated":
\"\",\r\n
"2021-09-15T14:55:20.4327369",
\"Optional\":
false,\r\n
\
"
Desc\
dateModified":
\"Your SQL server.\",\r\n
"2022-02-01T09:56:16.9089015",
\"Hidden\": false\r\n },\r\n {\r\n
"dateLastRun": "2021-09-15T14:59:02.95+00:00",
\
"
ShortName\
dateNextSchedule":
\"database\",\r\n
null,
\
"
Name\
regApplicationIds": [
\"Database name\",\r\n
\"Type\":
\"text\",\r\n
\"Value\": \"\",\r\n
"dbdd41cf-28de-4d2d-9771-7105c2165bcf"
\"Optional\":
false,\r\n
\"Desc\": \"Your SQL database name\",\r\n
],
\
"
Hidden\
currentBlock":
false\r\n
 1
    },
\r\n

    {
\r\n
\
"
ShortName\
id":
\"user\",\r\n
"f01eccf9-f56c-420a-9da3-e938291514e8",
\"Name\":
\"SQL
user\",\r\n
\
"
Type\
name":
\
"
text\
Random",
\r\n
\"Value\":
\"\",\r\n
\
"
Optional\
description":
false,\r\n
"Random",
\
"
Desc\
status":
\"Your SQL database user.\",\r\n
"Ready",
\
"
Hidden\
isScheduled": false
\r\n
,
},\r\n
{\r\n
\
"
ShortName\
schedulerFrequency": "{\"
password
cronSchedule\"
,\r\n \"Name\": \"SQL password\",\r\n
:\"0 0 0/1 ? * * *\"}",
\
"
Type\
workflowTemplateId":
\"password\",\r\n
null,
\"Value\":
\"\",\r\n
\
"
Optional\
isCustomizedStructure": false,
\r\n
\
"
Desc\
accountId":
\"Your SQL database password.\",\r\n
"6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
\
"
Hidden\
organizationId":
false\r\n },\r\n {\r\n
 "00000000-0000-0000-0000-000000000001",
\
"
ShortName\
dateCreated":
\"connectorkey\",\r\n
"2021-03-31T09:09:31.1665459",
\
"
Name\
dateModified":
\"CloudConnector key\",\r\n
"2021-11-26T16:37:10.8509085",
\
"
Type\
dateLastRun":
\"text\",\r\n
"2021-11-26T16:37:12.128+00:00",
\"Value\":
\"\",\r\n
\
"
Optional\
dateNextSchedule":
false,\r\n
"2021-09-20T11:00:00+00:00",
\
"
Desc\
regApplicationIds":
\"Your CloudConnector key.\",\r\n
[
\"Hidden\":
false\r\n
}\r\n]",
  "1c08aaa2-52ae-4e74-bb9d-108f6f36b8a8"
"tag":
"Database
Engine
],
Premium",

        "
sessionTimeMins
currentBlock":
0,
4
"sessionSlidingExpiry": false }, { 
}
]

Workflow (get)

Returns registered workflow by id

Expand
titleGET https://<base-url>/Workflow/b459cf22-ad18-44bf-80dc-6e8b78be1cc5

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED

SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

ManagedAccountId:a4ba9a9b-ce81-4f06-81c6-032bf7d648f5

Info

ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access

Expand
titleResponse (status 200)
Code Block
languagejson
{
    
"id": "
8c1d775c
b459cf22-
5f05
ad18-
4e9a
44bf-
8c8e
80dc-
fef2aefc0255
6e8b78be1cc5",
    
"name": "
Visma
Order
Business
transferring",
    "description": "Transfer orders from
"shortName": "VISB", 
MyStore into Tripletex invoices with payments",
    "
description
status": "
ERP and accounting
Ready",
    
"
vendorUrl
isScheduled":
null
false,

    
"
credentialFields
schedulerFrequency": "
[\r\n 
{\
r\n \"ShortName
"cronSchedule\":
\"
username\",\r\n \"Name\": \"User name\",\r\n
0 0 0/1 ? * * *\"}",
\"Type\":
\
"
text\
workflowTemplateId"
,\r\n
: null,
\
"
Value\
isCustomizedStructure":
\"\",\r\n
false,
\
"
Optional\
accountId":
false,\r\n
"6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
\
"
Desc\
organizationId":
\"Your Visma Business services user name.\",\r\n
"00000000-0000-0000-0000-000000000001",
    "dateCreated": "2022-03-24T18:08:22.2543998",
\
"
Hidden\
dateModified":
false\r\n },\r\n {\r\n
"2022-04-12T10:36:56.478261",
\
"
ShortName\
dateLastRun":
\"password\",\r\n
"2022-04-12T10:36:57.877+00:00",
\
"
Name\
dateNextSchedule":
\"Password\",\r\n
"2022-04-05T17:00:00+00:00",
\
"
Type\
regApplicationIds":
\"password\",\r\n
 [
\"Value\":
\"\",\r\n
"281686d9-aedd-4359-89b4-8f878ad43b35",
\"Optional\":
true,\r\n
\"Desc\": \"Your Visma Business services password.\",\r\n
"03548816-f945-4bb2-b66e-950dff826fb8"
    ],
\
"
Hidden\
currentBlock":
false\r\n },\r\n {\r\n
3
}

Workflow (post)

Registers a new workflow based on template

Expand
titlePOST https://<base-url>/Workflow

Body JSON structure:

AddWorkflowApiDto

Body example:

Code Block
languagejson
{
\
"
ShortName\
workflowTemplateId":
\"companyno\",\r\n
"bbe52876-aca2-4ece-ba31-11e0d98ddc19",
\
"
Name\
name":
\"Company number\",\r\n
"Test Quinyx Employee Export Into FTP(CSV)",
\
"
Type\
applications":
\"text\",\r\n \"Value\": \"\",\r\n
{"QUIN":"e3320a16-4b20-4e33-840f-2f5d28e3e1ca", "FTP":"0741b73d-2b13-4a4a-a0c2-2ffad9548e06"},
\
"
Optional\
chain":
false,\r\n
[
            {
\"Desc\":
\"Your
Visma
Business
company
number.\",\r\n
\
"
Hidden\
uniqueBlockId":
true\r\n },\r\n {\r\n
"02d1424a-da90-4c12-9c28-96162e624bd7",
\"ShortName\":
\"culture\",\r\n
\
"
Name\
variables":
\"Language\",\r\n
{
\"Type\":
\"text\",\r\n
\"Value\":
\"\",\r\n
\"Optional\":
false,\r\n
\
"
Desc\
apiKeys":
\"The language setting you use in Visma Business.\",\r\n
["xxxx-xxxx-xxxx-xxxx"],
\"Hidden\":
true\r\n
},\r\n
{\r\n
\
"
ShortName\
badgeNo":
\"connectorkey\",\r\n
 null
\"Name\":
\"CloudConnector key\",\r\n
\"Type\":
\"text\",\r\n 
 }
\"Value\":
\"\",\r\n
\"Optional\":
false,\r\n
\"Desc\": \"Your CloudConnector key.\",\r\n
}
\"Hidden\":
true\r\n
 ]
}
\r\n]",
"tag": "erp,finance,accounting,Premium", "sessionTimeMins": 0, 
Headers:
Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED
SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7
ManagedAccountId:a4ba9a9b-ce81-4f06-81c6-032bf7d648f5
 Info
ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access
 Expand
titleResponse (status 200)
 Code Block
languagejson
"0fdfd78c-258f-49ed-9e8c-faef9d6598fa"
 Expand
titleResponse (status 401)
Status Code: 401; Unauthorized
 Expand
titleResponse (status 500)
 Code Block
{
    "State": 500,
    "
sessionSlidingExpiry
Msg": 
false
"Unknown workflow 
   },
    {
        "id": "b5a4a9ed-a686-4b1e-af30-ffd84b7fb2e0",
        "name": "Talent Manager",
        "shortName": "HRTM",
        "description": "HR solution",
template 1be52876-aca2-4ece-ba31-11e0d98ddc19"
}
DeleteWorkflow
Removes workflow by Id
 Expand
titleGET https://<base-url>/DeleteWorkflow/7b2dee52-5781-49bf-9895-d6d2b2b43e2c
Headers:
Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED
SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7
ManagedAccountId:a4ba9a9b-ce81-4f06-81c6-032bf7d648f5
 Info
ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access
 Expand
titleResponse (status 200)
 Code Block
languagejson
true
 Expand
titleResponse (status 401)
Status Code: 401; Unauthorized
RunWorkflow
Runs workflow or needed blocks
 Expand
titlePOST https://<base-url>/RunWorkflow
Body JSON structure:
RunMetadataApiDto
Body example 1 for running by default:
 Code Block
languagejson
{   
   
  
"
vendorUrl
workflowId": "
http://www.hr-manager.net",
0fdfd78c-258f-49ed-9e8c-faef9d6598fa"
}            
"credentialFields": "[\r\n  {\r\n
Body example 2 for running from start till block #2:
 Code Block
languagejson
{   
   
\
"
ShortName\
workflowId": 
\"customeralias\",\r\n
"0fdfd78c-258f-49ed-9e8c-faef9d6598fa",
   
\
"
Name\
runTillBlock": 
\"Customer alias\",\r\n
2
}    
\"Type\":
 
\"text\",\r\n
    
\"Value\":
 
\"\",\r\n    \"Optional\": false,\r\n
  
Body example 3 for running of blocks between #2 and #4:
 Code Block
languagejson
{   
   
\
"
Desc\
workflowId": 
\"Your customer alias.\",\r\n
"0fdfd78c-258f-49ed-9e8c-faef9d6598fa",
   
\
"
Hidden\
runFromBlock": 
false\r\n
2,
 
},\r\n
  
{\r\n 
"runTillBlock": 4 
} 
\"ShortName\":
 
\"apikey\",\r\n
    
\"Name\":
 
\"Your
 
API
 
key\",\r\n
    
\"Type\": \"text\",\r\n    \"Value\": \"\",\r\n    \"Optional\": false,\r\n    \"Desc\": \"Your API key.\",\r\n    \"Hidden\": false\r\n  }\r\n]",
Headers:
Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED
SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7
ManagedAccountId:a4ba9a9b-ce81-4f06-81c6-032bf7d648f5
 Info
ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access
 Expand
titleResponse (status 200)
 Code Block
languagejson
Workflow will now run
 Expand
titleResponse (status 401)
Status Code: 401; Unauthorized
WorkflowScheduler
Sets ON/OFF a workflow scheduler. The scheduler frequency should be set in CRON format. 
 Expand
titlePOST https://<base-url>/WorkflowScheduler
Body JSON structure:
UpdateWorkfowSchedulerApiDto
Body example:
 Code Block
languagejson
{   
   
  
"
tag
workflowId": "
HR
0fdfd78c-258f-49ed-9e8c-faef9d6598fa",
   "isScheduled": true,
   "scheduleFrequency": "
sessionTimeMins
{\"cronSchedule\":\"0 0
,
/5 * ? * * *\"}"
}    
"sessionSlidingExpiry": false
    }
]
      
Headers:
Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED
SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7
ManagedAccountId:a4ba9a9b-ce81-4f06-81c6-032bf7d648f5
 Info
ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access
 Expand
titleResponse (status 200)
 Code Block
languagejson
Workflow Scheduler enabled
or
 Code Block
Workflow Scheduler disabled
 Expand
titleResponse (status 401)
Returned if the Authorization is incorrect or missing.Status Code: 401; Unauthorized