Create Connector

Creates a connector.

Connectors allow you to retrieve information from external systems and update it through Haven OnDemand APIs. You can use it to create an index of the data in the external repository, automate workflows, for notifications, or to facilitate migration to other locations.

The Create Connector API allows you to create a connector configuration to connect to the external repository, and specifies what content to retrieve. You can create a schedule so that Haven OnDemand automatically runs the connector. For Cloud flavor connectors, you can manually run the connector by using the Start Connector API.

Quick Start

To create a connector, you must specify the connector, flavor, config, and destination parameters.

The connector parameter can be any value that allows you to identify the connector.

The currently available values for flavor are:

  • web_cloud. Connects to a Web resource and retrieves its content. For details of the available configuration options, see Web Cloud Connector.

  • dropbox_cloud. Connects to your Dropbox account and retrieves its content. For details of the available configuration options, see Dropbox Cloud Connector.

  • exchange_cloud. Connects to your Exchange Online account and retrieves the content of user mailboxes. For details of the available configuration options, see Exchange Cloud Connector.

  • imap_cloud. Connects to your IMAP email mailbox and retrieves its content. For details of the available configuration options, see Imap Cloud Connector.

  • jive_cloud. Connects to your Jive community and retrieves its content. For details of the available configuration options, see Jive Cloud Connector.

  • sharepoint_cloud. Connects to a SharePoint repository and retrieves its content. For details of the available configuration options, see SharePoint Cloud Connector.

  • twitter_cloud. Connects to Twitter by using your account and retrieves Twitter content. For details of the available configuration options, see Twitter Cloud Connector.

  • web_onsite. Connects to a Web resource (including local resources) and retrieves its content. For details of the available configuration options, see Web Onsite Connector.

  • filesystem_onsite. Connects to directories in a local file system and retrieves its content. For details of the available configuration options, see File System Onsite Connector.

  • sharepoint_onsite. Connects to a local SharePoint repository and retrieves its content. For details of the available configuration options, see SharePoint Onsite Connector.

The config parameter takes a JSON object, which contains parameters relevant to the connector flavor. The following example configuration for a Web Cloud connector retrieves content from the havenondemand.com website:

{ "url" : "http://www.havenondemand.com" }

The destination parameter takes a JSON object specifying the destination action and additional destination parameters. Currently the only destination action available is addtotextindex, which uses the Add to Text Index API to add the content to a text index. In the JSON object, use the action parameter to specify the type, and use the index parameter to specify the text index that you want to add to. For example:

 { "action" : "addtotextindex", "index" : "myindex" }

This example adds the connector data to the myindex text index.

If you want to run the connector automatically on a regular basis, you can specify a schedule using the following JSON format:

 { "frequency" : { "frequency_type" : "seconds", "interval" : 21600 } }

This example configures the connector to run every 21600 seconds (6 hours).

If you do not set the schedule parameter:

  • Cloud flavor connectors do not run on a schedule. In this case, you can use the Start Connector API to run the connector when required.

  • Onsite flavor connectors runs each time you start the onsite connector service.

For full details of the options available for config, schedule, and destination for each connector flavor, see the individual connector flavor documentation (listed above, and on the Connectors page).

Note: To ensure a consistent service, Haven OnDemand limits the frequency at which you can schedule connector runs. For free users, the minimum schedule interval is 21600 seconds (6 hours). For more information about connector quotas, see Rate Limiting, Quotas, Data Expiry, and Maximums, and the individual connector flavor documentation.

Synchronous
https://api.havenondemand.com/1/api/sync/createconnector/v1
Asynchronous
https://api.havenondemand.com/1/api/async/createconnector/v1
Authentication

This API requires an authentication token to be supplied in the following parameter:

Parameter Description
apikey The API key to use to authenticate the API request.
Parameters

This API accepts the following parameters:

Required
Name Type Description
flavor
enum The flavor of the connector to create. See Connectors.
connector
new_resource The name of the connector to create. Maximum length of 100 characters.
config
json A JSON object defining the connector configuration. For details of the available properties, see the individual connector flavor documentation. See Connectors.
destination
json A JSON object defining the destination to which the connector must send retrieved data. Currently it can send data only to a text index. For details of the available properties, see the individual connector flavor documentation. See Connectors.
Optional
Name Type Description
credentials
json The user credentials to use to access the source repository. For details of the available properties, see the individual connector flavor documentation. See Connectors.
credentials_policy
json The user credentials_policy to verify the validity of the keys for decryption. For details of the available properties, see the individual connector flavor documentation. See Connectors.
description
string A brief description of the connector. Maximum length is 255 characters.
schedule
json A JSON string containing the details of the schedule. For details of the available properties, see the individual connector flavor documentation. See Connectors.
Enumeration Types

This API's parameters use the enumerations described below:

flavor
The flavor of the connector to create.
web_cloud Cloud Web Connector.
A cloud-based connector for retrieving content from Web pages.
dropbox_cloud Dropbox Cloud Connector
A cloud-based connector for retrieving content from your Dropbox account.
exchange_cloud Exchange Cloud Connector
A cloud-based connector for retrieving content from your Exchange Online mailboxes.
imap_cloud IMAP Cloud Connector
A cloud-based connector for retrieving content from your IMAP mailboxes.
jive_cloud Jive Cloud Connector
A cloud-based connector for retrieving content from your Jive community.
sharepoint_cloud Cloud SharePoint Connector
A cloud-based connector for retrieving content from a SharePoint Remote server.
twitter_cloud Twitter Cloud Connector
A cloud-based connector for retrieving content from Twitter.
web_onsite OnSite Web Connector.
An onsite connector for retrieving content from Web pages.
filesystem_onsite OnSite Filesystem Connector
An onsite connector for retrieving content from a file system.
sharepoint_onsite OnSite SharePoint Connector
An onsite connector for retrieving content from a SharePoint Remote server.

This API returns a JSON response that is described by the model below. This single model is presented both as an easy to read abstract definition and as the formal JSON schema.

Asynchronous Use

Additional requests are required to get the result if this API is invoked asynchronously.

You can use /1/job/status/<job-id> to get the status of the job, including results if the job is finished.

You can also use /1/job/result/<job-id>, which waits until the job has finished and then returns the result.

Model
This is an abstract definition of the response that describes each of the properties that might be returned.
Create Connector Response {
connector ( string ) The name of the connector.
download_link ( Download_link , optional) Object of download links to available connector installers for different operating systems and CPU architectures. This will only be available if created connector is an "onsite" flavor connector.
message ( string ) Indicates that the connector was created.
}
Create Connector Response:Download_link {
linux_x86 ( string , optional) Download link to Linux 32-bit connector installer.
linux_x86_64 ( string , optional) Download link to Linux 64-bit connector installer.
windows_x86 ( string , optional) Download link to Windows 32-bit connector installer.
windows_x86_64 ( string , optional) Download link to Windows 64-bit connector installer.
}
Model Schema
This is a JSON schema that describes the syntax of the response. See json-schema.org for a complete reference.
{
    "properties": {
        "connector": {
            "type": "string"
        },
        "download_link": {
            "properties": {
                "linux_x86": {
                    "type": "string"
                },
                "linux_x86_64": {
                    "type": "string"
                },
                "windows_x86": {
                    "type": "string"
                },
                "windows_x86_64": {
                    "type": "string"
                }
            },
            "type": "object"
        },
        "message": {
            "type": "string"
        }
    },
    "required": [
        "message",
        "connector"
    ],
    "type": "object"
}


If you would like to provide us with more information then please use the box below:

We will use your submission to help improve our product.