You can send requests to third-party applications throught Core REST API. List of supported third-party applications you can get by following link https://connectmyapps.com/Integrations.
This page documents the REST resources available in Core REST API, including the HTTP response codes and example requests and responses:
Table of Contents |
---|
Base URL for environments:
...
PRD - https://cloudmanager.connectmyapps.com/api/
IP restriction
You can send Core REST API requests just from availabled servers, which are in white list.
If you want to allow access from some IP addresseschange it, 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.
Use following authentication request for checking your access keys
Endpoints and requests
All requests can be send with URL based on following mask
https://<base-url>/apps/<app-short-name>/<endpoint>
and following headers
Consumer: 5D1AEF055555597182992E000007FFFD0FED85F7777742B19CE02AB5ED62D6ED
Authorization: Bearer E71B48D1F72C468199FB7DD81C3C5999999928268547098F60D5B1E3B19A49
AppKey: 6167D3D5924CE89DCEEE45C2592C8C
SessionKey: 9F8892419CF447C3E567AA21CEBCD47A4C748064345659A54382F37262BEF
CMAproject: CANVAS:PRD
where:
Expand | ||
---|---|---|
| ||
DEV - eu3api.connectmyapps.com |
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Takes a value in depending of application which you want to integrate with
|
Expand | ||
---|---|---|
| ||
The list of supported endpoints you can get by meta request. |
Expand | ||
---|---|---|
| ||
Consumer/Authorization - the key pair of account identification AppKey/SessionKey - the key pair of application identification All keys can be gotten on Canvas Applications page |
Expand | ||
---|---|---|
| ||
DEV: CANVAS:DEV PRD: CANVAS:PRD |
Example:
Expand | ||
---|---|---|
| ||
Headers: consumer: 5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED |
Expand | ||
---|---|---|
| ||
[ |
Authentication
All applications have Authenticate endpoint, which has different headers with dependency of application kind. There is an example for Canvas application:
Expand | ||
---|---|---|
| ||
Headers: secretkey:37be7d8a-e9df-42ba-9039-4832d095cc85 |
Expand | ||
---|---|---|
| ||
|
Expand | ||
---|---|---|
|
APIs for help
There are two APIs, which describes list of all provided APIs
...
Provided public key is invalid. An application could not be found matching the provided application key. |
Meta
For getting of all provided APIs you need to send following request:
Expand | ||
---|---|---|
| ||
Expand | ||
---|---|---|
| ||
|