Connector - Local

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.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/connector/local/{connectorId}/group/{groupId}

Parameters

propertyvaluedescription
connectorId guid The connector's ID
groupId guid The group Id for which you want to get the connector's local configuration

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-68380bbbc115",
    "type": {
      "id": 2,
      "name": "ChatVilla",
      "thumbUrl": "http://demo.hivesocialnow.com/App_Themes_Main/images/admin/chat.png"
    },
    "name": "ChatVilla connector",
    "description": "Chatvilla is a real time chat application module",
    "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": {
      "inheritSettings": false,
      "applicationId": "e532e792-4101-4ef5-8cd7-68380bbbc703",
      "applicationSecret": "secretKey",
      "allowGuest": false
    },
    "accessWarnings": []
  }
}

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

propertyvaluedescription
name string The connector identifier in the list. Can be modified only for the creatable ones.
description string A few words about the connector. Can be modified only for the creatable ones.
connectorType object Defines the connector type with its id, name and thumbnail as the visual representation.
isEnabled boolean Whether this connector is enabled for this group in the system. If disabled it will not operate at all in any group.
createdOn date When the connector was created in ISO 8601 string format and UTC time zone.
author object some common properties of the user that created the record: id, alias, extendedAlias, slug, avatarUrl, url (of the profile page)
modifiedOn date When the connector was last modified in ISO 8601 string format and UTC time zone.
editor object some common properties of the user that modified the record last: id, alias, extendedAlias, slug, avatarUrl, url (of the profile page)
groups List (object) list of group objects, for which this connector is enabled
settings object the local group configuration of this connector. The properties of this object are different for each of the connector types. You can review them in detail below.

The connectors that can be managed locally are:

ChatVilla connector

Chatvilla is a real time chat application module. These are the ChatVilla application local settings for this group.

"settings":  {
	 "inheritSettings":  false,
	 "applicationId": "e532e792-4101-4ef5-8cd7-68380bbbc703",
	 "applicationSecret": "secretKey",
	 "allowGuest":  false
}
propertyvaluedescription
inheritSettings string Whether the local connectors to inherit the parent group's ChatVilla connector settings by default
applicationId string Your ChatVilla application id
applicationSecret string Your ChatVilla application secret
allowGuest boolean Whether to allow users not logged in your HiveSocial system, to use chat application in this group.

SalesForce connector

Currently the SalesForce connector can be only enabled or disabled on a local group level, thus its local settings object is empty

"settings":  {}

Method: list

Authorization is required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/connector/local/list/group/{groupId}

Parameters

propertyvaluedescription
groupId guid The bookmarks group's ID

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 connectors local configurations in its object.connectors array

Method: update

Authorization is required.

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/connector/local/{connectorId}/group/{groupId}

Parameters

propertyvaluedescription
connectorId guid The connector's ID
groupId guid The group Id for which you want to get the connector's local configuration

Request body

propertyvaluedescription
inheritSettings boolean If TRUE the connector will inherit the configurations from its group parent. If FALSE it will apply its own set of settings.
isEnabled boolean If TRUE the connector will be enabled for this group. If FALSE it will be disabled.
settings object This object has connector specific set of properties as defined below.

ChatVilla connector

Chatvilla is a real time chat application module. These are the ChatVilla application local settings for this group.

"settings":  {
	 "inheritSettings":  false,
	 "applicationId": "e532e792-4101-4ef5-8cd7-68380bbbc703",
	 "applicationSecret": "secretKey",
	 "allowGuest":  false
}
propertyvaluedescription
inheritSettings string Whether the local connectors to inherit the parent group's ChatVilla connector settings by default
applicationId string Your ChatVilla application id
applicationSecret string Your ChatVilla application secret
allowGuest boolean Whether to allow users not logged in your HiveSocial system, to use chat application in this group.

SalesForce connector

Currently the SalesForce connector can be only enabled or disabled on a local group level, thus its local settings object is empty

"settings":  {}

Response

If successful, this method returns a response JSON containing the updated object.

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

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
errors List (object) List of validation errors, if any. The "key" property value is matched to one of the record's fields
object object The object that caused the validation errors or that was updated. Have in mind that, if the server requires string trimming or data manipulation after the user submission, it is applied in this object. In this way the returned object can differe from the posted one.

Method: update status

Authorization is required.

Request

HTTP request

PATCH https://<YOUR_DOMAIN>/api/v1/en_US/connector/local/{connectorId}/status

Parameters

propertyvaluedescription
connectorId integer In id of the updated record

Request body

propertyvaluedescription
group guid The group Id for which you want to change the connector's status
isEnabled boolean Whether the connector is enabled or disabled for this group available

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.

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
errors List (object) List of validation errors, if any. The "key" property value is matched to one of the record's fields
object object The updated connector object