Versions Compared

Old Version 11

changes.mady.by.user Natalia Yudnikova

Saved on

compared with

New Version 12

changes.mady.by.user Natalia Yudnikova

Saved on

Key

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

...

All applications have Authenticate endpoint Use following authentication request for checking your access keys, 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:DEV

Expand
titleResponse (status 200)
Code Block
614506FB0E064B4DB2C1F404A17CB97E67A4497EF141447A860FAD944B8754BB
Expand
titleResponse (status 401)

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:

Headers:

consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED
authorization:Bearer E71B48D1F72C468199FB7DD81C3C576112A33728268547098F60D5B1E3B19A49appKey:58ED3E69F7634EC7AF2FC8D7D69467C1
sessionKey:614506FB0E064B4DB2C1F404A17CB97E67A4497EF141447A860FAD944B8754BB
CMAproject:CANVAS:DEV
Expand
titleGET https://<base-url>/apps/myst2canv/meta

Expand
titleResponse (status 200)
Code Block
[
    {
        "name": "meta",
        "parameters": "boolean detailedinfo",
        "verb": "GET",
        "authenticate": false,
        "requires_session": false,
        "description": "(Not available)"
    },
    {
        "name": "applicationsconfig",
        "parameters": "nullable`1 managedaccountid",
        "verb": "GET",
        "authenticate": false,
        "requires_session": true,
        "description": "(Not available)"
    },
    {
        "name": "clientsconfig",
        "parameters": "nullable`1 managedaccountid",
        "verb": "GET",
        "authenticate": false,
        "requires_session": true,
        "description": "(Not available)"
    },
    {
        "name": "regapplicationsconfig",
        "parameters": "nullable`1 managedaccountid",
        "verb": "GET",
        "authenticate": false,
        "requires_session": true,
        "description": "(Not available)"
    },
    {
        "name": "authenticate",
        "parameters": "",
        "verb": "GET",
        "authenticate": true,
        "requires_session": false,
        "description": "(Not available)"
    },
    {
        "name": "applications",
        "parameters": "nullable`1 managedaccountid",
        "verb": "GET",
        "authenticate": false,
        "requires_session": true,
        "description": "(Not available)"
    },
    {
        "name": "regapplications",
        "parameters": "nullable`1 managedaccountid",
        "verb": "GET",
        "authenticate": false,
        "requires_session": true,
        "description": "(Not available)"
    },
    {
        "name": "regapplication",
        "parameters": "jobject body, nullable`1 managedaccountid",
        "verb": "POST",
        "authenticate": false,
        "requires_session": true,
        "description": "(Not available)"
    },
    {
        "name": "accounts",
        "parameters": "nullable`1 managedaccountid",
        "verb": "GET",
        "authenticate": false,
        "requires_session": true,
        "description": "(Not available)"
    },
    {
        "name": "account",
        "parameters": "jobject body",
        "verb": "POST",
        "authenticate": false,
        "requires_session": true,
        "description": "(Not available)"
    },
    {
        "name": "workflowtemplates",
        "parameters": "nullable`1 managedaccountid",
        "verb": "GET",
        "authenticate": false,
        "requires_session": true,
        "description": "(Not available)"
    },
    {
        "name": "workflows",
        "parameters": "nullable`1 managedaccountid",
        "verb": "GET",
        "authenticate": false,
        "requires_session": true,
        "description": "(Not available)"
    },
    {
        "name": "workflow",
        "parameters": "guid id, nullable`1 managedaccountid",
        "verb": "GET",
        "authenticate": false,
        "requires_session": true,
        "description": "(Not available)"
    },
    {
        "name": "workflow",
        "parameters": "jobject body, nullable`1 managedaccountid",
        "verb": "POST",
        "authenticate": false,
        "requires_session": true,
        "description": "(Not available)"
    },
    {
        "name": "runworkflow",
        "parameters": "jobject body, nullable`1 managedaccountid",
        "verb": "POST",
        "authenticate": false,
        "requires_session": true,
        "description": "(Not available)"
    },
    {
        "name": "workflowscheduler",
        "parameters": "jobject body, nullable`1 managedaccountid",
        "verb": "POST",
        "authenticate": false,
        "requires_session": true,
        "description": "(Not available)"
    },
    {
        "name": "deleteworkflow",
        "parameters": "guid id, nullable`1 managedaccountid",
        "verb": "GET",
        "authenticate": false,
        "requires_session": true,
        "description": "(Not available)"
    }
]