XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The API provides functionality to update a tenants own settings.

Request

{
    "FacebookDisplayType":1,
    "FacebookApplicationId":"01e7efe0-5f20-4913-a4a7-fe539e7c762f",
    "FacebookRedirectUri":"59b14e8b-71e4-42a2-96eb-a4fa624a7245",
    "FacebookApplicationSecretKey":"93687750-d936-45ab-a306-5696bb7f97bd",
    "IsCDNEnabled":true,
    "CDNUrl":"fadefe08-a002-4f25-9e16-3c7a143fbd3a",
    "CacheExpirationTime":2147483647,
    "IsPassbookEnabled":true,
    "PassbookPassTypeIdentifier":"bc424b12-85aa-44f7-be36-bdd5e977ff61",
    "PassbookWWDRCACertificateTenantAssetId":"54f25df1-8dee-416b-91e6-1b91258e9945",
    "PassbookCertificateTenantAssetId":"9c0ffcb5-c889-41be-9936-ccd1e028baff",
    "PassbookCertificatePassword":"b85c42da-c80d-4c04-b074-b22e15fce4b6",
    "PassbookTeamIdentifier":"67a49a80-ff62-4999-84ec-0f790091bcc3",
    "PassbookOrganizationName":"409aa2ea-c619-469f-b2d3-db9723fc6466",
    "PopularityTimeImpactValue":10,
    "SearchIndexingEnabled":true,
    "TwitterConsumerKey":"01e7efe0-5f20-4913-a4a7-fe539e7c762f",
    "TwitterConsumerKeySecret":"59b14e8b-71e4-42a2-96eb-a4fa624a7245",
    "TwitterRedirectUri":"93687750-d936-45ab-a306-5696bb7f97bd",
    "MailUnsubscribeRedirectionUri":"www.xomni.com",
    "IsAnalyticsEnabled":true
}
HTTP Method Resource URI
PUT https://{tenantName}.api.xomni.com/management/configuration/settings

Request Body Description

Parameter Name Description Type Conditions
MailUnsubscribeRedirectionUri Redirection URI when user clicks unsubscribe link in mails sent from XOMNI. String
FacebookDisplayType Type of Facebook authorization page. Number
FacebookApplicationId Unique id of the facebook application. String
FacebookRedirectUri Uri of the web page where facebook redirects when the authorization process is completed. String
FacebookApplicationSecretKey Unique application secret key for the facebook application. String
IsCDNEnabled Boolean field indicating if asset APIs should return CDN endpoints or regular endpoints. Unknown
CDNUrl Base url of the CDN endpoint. String
CacheExpirationTime Cache expiration time for the CDN nodes. Number
IsPassbookEnabled Boolean field indicating if passbook functionality is enabled. Unknown
PassbookPassTypeIdentifier Required field by Apple (See Apple Documentation) String
PassbookWWDRCACertificateTenantAssetId Asset id of the passbook WWDRCA certificate. (See Asset API Documentation). Required field by Apple (See Apple Documentation). Number
PassbookCertificateTenantAssetId Asset ID of the passbook certificate. (See Asset API Documentation). Required field by Apple (See Apple Documentation). Number
PassbookCertificatePassword Certificate Password Required field by Apple (See Apple Documentation) String
Max Length: 250
PassbookTeamIdentifier Apple Team Identifier Required field by Apple (See Apple Documentation). String
Max Length: 250
PassbookOrganizationName Organization Name for Passbook Required field by Apple (See Apple Documentation). String
Max Length: 250
PopularityTimeImpactValue Indicates the value of the time for the popularity calculation logic. Number
SearchIndexingEnabled Boolean field indicating if search indexing is enabled. Unknown
TwitterConsumerKey Unique consumer key of the twitter application. String
TwitterConsumerKeySecret Unique consumer key secret of the twitter application. String
TwitterRedirectUri Uri of the web page where twitter redirects when the authorization process is completed. String
IsAnalyticsEnabled Boolean field indicating if analytics functionality is enabled. Boolean

Possible values for FacebookDisplayType

Value Description
0 If you are using the URL redirect dialog implementation, then this will be a full page display, shown within Facebook.com. This display type is called page.
1 You can open facebook authorization page in a popup window. This display type is called popup.
2 You can use touch enabled facebook authorization page in your mobile applications. This display type is called touch.

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-0, */*
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da

Response

{
    "FacebookDisplayType":1,
    "FacebookApplicationId":"01e7efe0-5f20-4913-a4a7-fe539e7c762f",
    "FacebookRedirectUri":"59b14e8b-71e4-42a2-96eb-a4fa624a7245",
    "FacebookApplicationSecretKey":"93687750-d936-45ab-a306-5696bb7f97bd",
    "IsCDNEnabled":true,
    "CDNUrl":"fadefe08-a002-4f25-9e16-3c7a143fbd3a",
    "CacheExpirationTime":2147483647,
    "IsPassbookEnabled":true,
    "PassbookPassTypeIdentifier":"bc424b12-85aa-44f7-be36-bdd5e977ff61",
    "PassbookWWDRCACertificateTenantAssetId":"54f25df1-8dee-416b-91e6-1b91258e9945",
    "PassbookCertificateTenantAssetId":"9c0ffcb5-c889-41be-9936-ccd1e028baff",
    "PassbookCertificatePassword":"b85c42da-c80d-4c04-b074-b22e15fce4b6",
    "PassbookTeamIdentifier":"67a49a80-ff62-4999-84ec-0f790091bcc3",
    "PassbookOrganizationName":"409aa2ea-c619-469f-b2d3-db9723fc6466",
    "PopularityTimeImpactValue":10,
    "SearchIndexingEnabled":true,
    "TwitterConsumerKey":"01e7efe0-5f20-4913-a4a7-fe539e7c762f",
    "TwitterConsumerKeySecret":"59b14e8b-71e4-42a2-96eb-a4fa624a7245",
    "TwitterRedirectUri":"93687750-d936-45ab-a306-5696bb7f97bd",
    "MailUnsubscribeRedirectionUri":"www.xomni.com",
    "IsAnalyticsEnabled":true
}

Response Body Description

Parameter Name Description Type
MailUnsubscribeRedirectionUri Redirection URI when user clicks unsubscribe link in mails sent from XOMNI. String
FacebookDisplayType Type of Facebook authorization page. Number
FacebookApplicationId Unique id of the facebook application. String
FacebookRedirectUri Uri of the web page where facebook redirects when the authorization process is completed. String
FacebookApplicationSecretKey Unique application secret key for the facebook application. String
IsCDNEnabled Boolean field indicating if asset APIs should return CDN endpoints or regular endpoints. Unknown
CDNUrl Base url of the CDN endpoint. String
CacheExpirationTime Cache expiration time for the CDN nodes. Number
IsPassbookEnabled Boolean field indicating if passbook functionality is enabled. Unknown
PassbookPassTypeIdentifier Required field by Apple (See Apple Documentation) String
PassbookWWDRCACertificateTenantAssetId Asset id of the passbook WWDRCA certificate. (See Asset API Documentation). Required field by Apple (See Apple Documentation). Number
PassbookCertificateTenantAssetId Asset ID of the passbook certificate. (See Asset API Documentation). Required field by Apple (See Apple Documentation). Number
PassbookCertificatePassword Certificate Password Required field by Apple (See Apple Documentation) String
PassbookTeamIdentifier Apple Team Identifier Required field by Apple (See Apple Documentation). String
PassbookOrganizationName Organization Name for Passbook Required field by Apple (See Apple Documentation). String
PopularityTimeImpactValue Indicates the value of the time for the popularity calculation logic. Number
SearchIndexingEnabled Boolean field indicating if search indexing is enabled. Unknown
TwitterConsumerKey Unique consumer key of the twitter application. String
TwitterConsumerKeySecret Unique consumer key secret of the twitter application. String
TwitterRedirectUri Uri of the web page where twitter redirects when the authorization process is completed. String
IsAnalyticsEnabled Boolean field indicating if analytics functionality is enabled. Boolean

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 PUT operations. Possible response status codes are as listed below:

Status Code Description
400 (Bad Request) Given setting values are inconsistent.