Versions Compared

Key

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

...

This page documents the REST resources available in Core REST API, including the HTTP response codes and example requests and responses:

Table of Contents

IP restriction

You can send Core REST API requests just from availabled servers, which are in white list.

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

Endpoints and requests

All requests can be send with URL based on following mask

...

Expand
titleCMAproject header takes a value in depending of needed environment database:

DEV: CANVAS:DEV

PRD: CANVAS:PRD

IP restriction

You can send Core REST API requests just from availabled servers, which are in white list.

...

Example:

Expand
titlehttps://cloudmanager.connectmyapps.com/api/apps/canv/applications

Headers:

consumer: 5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED
authorization: Bearer E71B48D1F72C468199FB7DD81C3C576112A33728268547098F60D5B1E3B19A49
appKey: 58ED3E69F7634EC7AF2FC8D7D69467C1
sessionKey: 614506FB0E064B4DB2C1F404A17CB97E67A4497EF141447A860FAD944B8754BB
CMAproject: CANVAS:PRD

Expand
titleResponse (status 200)

[
{
"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": [
{
"ShortName": "apiKey",
"Name": "API key",
"Type": "text",
"Value": "",
"Optional": false,
"Desc": "Your Arrowsphere API key.",
"Hidden": false
},
{
"ShortName": "environment",
"Name": "Environment",
"Type": "select",
"Value": "",
"Options": "live|Live Environment,test|Test Environment",
"Optional": false,
"Desc": "Choose which Arrowsphere environment you wish to use, live or test.",
"Hidden": false
}
],
"credentialsJson": {
"apiKey": null,
"environment": null
},
"tag": "Cloud",
"sessionTimeMins": 0,
"sessionSlidingExpiry": false
},
{
"id": "07ffd13d-ba57-4d1b-9c46-03c5c919eed0",
"name": "Talentsoft",
"shortName": "TASO",
"description": "HR",
"vendorUrl": "https://www.talentsoft.com/%22,
"credentialFields": [
{
"ShortName": "baseUrl",
"Name": "Base url",
"Type": "text",
"Value": "",
"Optional": false,
"Desc": "Talentsoft API url.",
"Hidden": false
},
{
"ShortName": "client_id",
"Name": "Client ID",
"Type": "text",
"Value": "",
"Optional": false,
"Desc": "Talentsoft client ID.",
"Hidden": false
},
{
"ShortName": "client_secret",
"Name": "Client secret",
"Type": "text",
"Value": "",
"Optional": false,
"Desc": "Talentsoft client secret.",
"Hidden": false
}
],
"credentialsJson": {
"baseUrl": null,
"client_id": null,
"client_secret": null
},
"tag": "Hr, Premium",
"sessionTimeMins": 0,
"sessionSlidingExpiry": false
},
{
"id": "b5a4a9ed-a686-4b1e-af30-ffd84b7fb2e0",
"name": "Talent Manager",
"shortName": "HRTM",
"description": "HR solution",
"vendorUrl": "http://www.hr-manager.net",
"credentialFields": [
{
"ShortName": "customeralias",
"Name": "Customer alias",
"Type": "text",
"Value": "",
"Optional": false,
"Desc": "Your customer alias.",
"Hidden": false
},
{
"ShortName": "apikey",
"Name": "Your API key",
"Type": "text",
"Value": "",
"Optional": false,
"Desc": "Your API key.",
"Hidden": false
}
],
"credentialsJson": {
"customeralias": null,
"apikey": null
},
"tag": "HR",
"sessionTimeMins": 0,
"sessionSlidingExpiry": false
}
]

Authentication

All applications have Authenticate endpoint, which has different headers with dependency of application kind. There is an example for Canvas application:

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

Headers:

secretkey:37be7d8a-e9df-42ba-9039-4832d095cc85
consumerkey: 5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED
environment:test
consumer: 5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED
authorization: Bearer E71B48D1F72C468199FB7DD81C3C576112A33728268547098F60D5B1E3B19A49
appKey: 58ED3E69F7634EC7AF2FC8D7D69467C1
sessionKey: 614506FB0E064B4DB2C1F404A17CB97E67A4497EF141447A860FAD944B8754BB
CMAproject: CANVAS:PRD

Expand
titleResponse (status 200)
Code Block
614506FB0E064B4DB2C1F404A17CB97E67A4497EF141447A860FAD944B8754BB

...