XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

This API returns a login URL for the particular social platform based on the {socialPlatformName} key.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/social/authurl/{socialPlatformName}

URI Parameters

Parameter Name Description Type Conditions
socialPlatformName Social platform name to get platform dependent authentication URL String

Possible values for available platforms

Value Description
facebook The key used for the Facebook social platform.
twitter The key used for the Twitter social platform.

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=
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

{  
   "Data":"https://www.facebook.com/dialog/oauth?display=popup&client_id=219137448225465&redirect_uri=http://test.apistaging.xomni.com&scope=user_about_me,publish_stream,read_stream&response_type=token"
}

Response Body Description

The URL returned by this API should be used to start a social platform authorization session. The API consumer application is responsible getting the right social platform token and provide it to XOMNI cloud services.

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

Status Code Description
400 (Bad Request) Configuration of this social platform is invalid. Please check social platform settings in tenant settings.
404 (Not Found) The value for the {socialPlatformName} key is not in the list of possible values.