XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API provides a way to fetch detailed API, API User and PII user information regarding to your API request.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/info/debug

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
PIIToken
Includes the base64-encoded “Personally Identifiable Information” data.
Sample: dXNlcm5hbWU6SW5uQXBwc1VzZXI7cGFzc3dvcmQ6SW5uQXBwc1Bhc3M=
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-1, */*

Response

{
    "AuthenticationSchema":"Basic",
    "ApiVersion":"v3_2",
    "ApiUserName":"publicuser",
    "ApiUserPassword":"1234567",
    "ApiUserFirstLastName":"Private User",
    "TenantUserName":"sampleuser@xomni.com",
    "TenantUserPassword":"123456",
    "TenantUserFirstLastName":"Sample User",
    "TenantHostName":"test.api.xomni.com",
    "PIICollection":{
        "username":"sampleuser@xomni.com",
        "password":"123456"
    }
}

Response Body Description

Parameter Name Description Type
AuthenticationSchema Authentication Schema info regarding to your API request. String
ApiVersion API versiong info regarding to your API request. String
ApiUserName Username of the API user regarding to your API request. String
ApiUserPassword Password of the API user regarding to your API request. String
ApiUserFirstLastName First name and last name of the API user regarding to your API request. String
TenantUserName Username of the PII user regarding to your API request. String
TenantUserPassword Password of the PII user regarding to your API request. String
TenantUserFirstLastName First name and last name of the PII user regarding to your API request. String
TenantHostName Host name info regarding to your API request. String
PIICollection Splitted values of PIIToken header regarding to your API request Array

Response Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.

Status Codes

A successful operation returns status code 200 (OK) for GET operations.