Alvaria Cloud Customer Experience Disposable App REST API v2.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Overview

The Alvaria™ Cloud Customer Experience REST API, provided by the CX Server, facilitates easy integration with other systems by providing access to the endpoints needed to interact with the Disposable App Feature

In order to utilize the Customer Experience REST API the customerexperienceapi scope is required.

Base URLs:

• https://orgId.via.aspect-cloud.net

License: License: Creative Commons Attribution 4.0 International Public License

Authentication

• oAuth2 authentication.

  • Flow: client crendentials
  • Authorization URL = https://myaspect.{region}.id.aspect-cloud.net/tokenservice/oauth2/access_token

Context

Get Context

Code samples

# You can also use wget
curl -X GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/disposableApp/context?sessionId=string \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'x-api-key: string'

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'x-api-key':'string'
};

fetch('https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/disposableApp/context?sessionId=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/disposableApp/context?sessionId=string HTTP/1.1
Host: orgid.via.aspect-cloud.net
Accept: application/json
Authorization: string
x-api-key: string

GET /via/v2/organizations/{orgId}/customerexperience/disposableApp/context

Returns the Context set on a disposable App object

Parameters

Example responses

200 Response

{
  "kind": "cxp#disposableAppContext",
  "content": "Context"
}

Responses

Outcome

Post Outcome

Code samples

# You can also use wget
curl -X POST https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/disposableApp/outcome?sessionId=string \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'x-api-key: string'

const fetch = require('node-fetch');
const inputBody = {
  "kind": "cxp#disposableAppOutcome",
  "variables": [
    {
      "id": "variable1",
      "value": "Value set by the external Web App"
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'string',
  'x-api-key':'string'
};

fetch('https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/disposableApp/outcome?sessionId=string',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/customerexperience/disposableApp/outcome?sessionId=string HTTP/1.1
Host: orgid.via.aspect-cloud.net
Content-Type: application/json
Accept: application/json
Authorization: string
x-api-key: string

POST /via/v2/organizations/{orgId}/customerexperience/disposableApp/outcome

This endpoint is called when the external disposable app is completed

Body parameter

{
  "kind": "cxp#disposableAppOutcome",
  "variables": [
    {
      "id": "variable1",
      "value": "Value set by the external Web App"
    }
  ]
}

Parameters

Example responses

400 Response

{
  "code": "400",
  "message": "Validation exception",
  "errors": [
    {
      "scope": "global",
      "reason": "Invalid request",
      "message": "The value for the channel is invalid"
    }
  ]
}

Responses

Schemas

Context

{
  "kind": "cxp#disposableAppContext",
  "content": "Context"
}

Properties

Outcome

{
  "kind": "cxp#disposableAppOutcome",
  "variables": [
    {
      "id": "variable1",
      "value": "Value set by the external Web App"
    }
  ]
}

Properties

ErrorResponse

{
  "code": "400",
  "message": "Validation exception",
  "errors": [
    {
      "scope": "global",
      "reason": "Invalid request",
      "message": "The value for the channel is invalid"
    }
  ]
}

Properties

Error

{
  "scope": "global",
  "reason": "Invalid request",
  "message": "The value for the channel is invalid"
}

Properties