Connector - Global

The connectors are the tool for integrating with other systems and software. The have two sets of configuration options - global (concerning the whole system or all groups that have this connector enabled) and local (concerning only the group your changing them for)

Method: get

Authorization is required. Get the global details of a connector.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/connector/global/{connectorId}

Parameters

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "success": true,
  "message": "Nisi proident tempor cillum sint duis eu elit dolor Lorem amet qui officia occaecat.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "id": "e532e792-4101-4ef5-8cd7-68380bbbc112",
    "type": {
      "id": 4,
      "name": "Authentication provider - Facebook.com",
      "thumbUrl": "http://demo.hivesocialnow.com/App_Themes_Main/images/admin/facebook.jpg"
    },
    "name": "Authentication provider - Facebook.com",
    "description": "Provides ability for users to sign in with their Facebook account",
    "accessTypeId": 2,
    "accessTypeName": "Private",
    "isEnabled": true,
    "createdOn": "2014-03-03T23:20:23Z",
    "author": {
      "id": "6b05b94e-e7c6-4bab-9377-e89ae1651425",
      "alias": "labore labore",
      "extendedAlias": "aute commodo eiusmod nisi labore",
      "slug": "Home",
      "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
      "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
    },
    "modifiedOn": "2014-03-03T23:20:23Z",
    "editor": {
      "id": "6b05b94e-e7c6-4bab-9377-e89ae1651425",
      "alias": "labore labore",
      "extendedAlias": "aute commodo eiusmod nisi labore",
      "slug": "Home",
      "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
      "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
    },
    "groups": [
      {
        "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
        "name": "fugiat",
        "slug": "Home",
        "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
        "url": "http://demo.hivesocialnow.com/Home/"
      }
    ],
    "settings": {
      "applicationId": "111198818571111",
      "applicationSecret": "111145990c25f117f4aa04e7bec11111"
    },
    "accessWarnings": []
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

The difference between the properties of each type of connector is in the object.settings object properties. There you can find all the specific configuration of the connector type - Facebook, Linkedin etc.

These settings objects can be defined as follows:

Authentication provider - Edu1World.org

Provides ability for users to sign in with their Edu1World account

"settings":  {}

All edu1world.org authentication settings are precoded.

Authentication provider - Facebook.com

Provides ability for users to sign in with their Facebook account

"settings":  {
	"applicationId":  "111111111111111",
	"applicationSecret" : "11111111111111111111111111111111"
}

Authentication provider - Twitter.com

Provides ability for users to sign in with their Twitter account

"settings":  {
	"applicationId":  "111111111111111",
	"applicationSecret" : "11111111111111111111111111111111"
}

Authentication provider - LinkedIn.com

Provides ability for users to sign in with their LinkedIn account

"settings":  {
	"applicationId":  "111111111111111",
	"applicationSecret" : "11111111111111111111111111111111"
}

Authentication provider - SalesForce.com

Provides ability for users to sign in with their SalesForce account

"settings":  {
	"applicationId":  "111111111111111",
	"applicationSecret" : "11111111111111111111111111111111"
}

Paypal connector

Paypal is a managing HiveSocial's premium content payments. This connector details are set in the web.config file.

"settings":  {
	 "currency": "USD",
	 "merchantEmail":  "domain@domain.com"
}

ChatVilla connector

Chatvilla is a real time chat application module. These are the ChatVilla application global settings. In each group you will need to set a local settings too.

"settings":  {
	 "apiUrl": "http://domain.com",
	 "scriptUrl":  "http://domain.com/script",
	 "inheritSettings":  false,
	 "applicationId": "e532e792-4101-4ef5-8cd7-68380bbbc703",
	 "applicationSecret": "secretKey",
	 "allowGuest":  false
}

SalesForce.com connector

Here are included all the instances of this connector type created by the administrator.

"settings":  {}

The settings are managed only on the local group level, as Local connectors

Method: list

Authorization is required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/connector/global/list

Parameters

Do not supply a request parameters with this method.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON. It will contain all the available global connectors in its object.connectors array

Method: create

Authorization is required.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/connector/global/add

Parameters

Do not supply a request parameters with this method.

Request body

SalesForce connector object properties

Response

If successful, this method returns a response JSON.

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

Method: update

Authorization is required.

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/connector/global/{connectorId}

Parameters

Request body

Connector object for type 3: Authentication provider - Edu1World.org

The update method does not support updating this type of connector.

Connector object for type 4: Authentication provider - Facebook.com

Connector object for type 5: Authentication provider - Twitter.com

Connector object for type 6: Authentication provider - LinkedIn.com

Connector object for type 7: Authentication provider - SalesForce.com

Connector object for type 8: Paypal connector

The update method does not support updating this type of connector. The settings for the Paypal integration are set in the web.config file.

Connector object for type 2: ChatVilla

Connector object for type 1: SalesForce connector

Response

If successful, this method returns a response JSON

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

Method: update-status

Authorization is required.

Request

HTTP request

PATHC https://<YOUR_DOMAIN>/api/v1/en_US/connector/global/{connectorId}/status

Parameters

Request body

Response

If successful, this method returns a response JSON with the following structure:

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

Method: test SalesForce connector

Authorization is required. This method will test the SalesForce integrations information.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/connector/global/test/salesforce-connection

Parameters

Do not supply a request parameters with this method.

Request body

Response

If successful, this method returns a response JSON with the following structure:

{
	"timestamp": "2014-03-03T23:20:23Z",	
	"success": true,
	"message": "connection successfully established!",
	"errors":[],
	"object": {}
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.