Find us at our new Help Center where we've combined our documentation and knowledgebase articles in one easy-to-search location.
We aren't updating the Developer Portal anymore, except for the Element Docs — all updates happen in the Help Center. We're retiring the Developer Portal as you know it in:
The Hub APIs allow you to retrieve information associated with each of the elements hubs that Cloud Elements supports.
There is no Cloud Elements Authorization requirement needed in order to access the Hubs APIs. The API calls allow you view all available Hubs, Hub keys, and Elements available in each hub.
[
"messaging",
"documents",
"esignature",
"idmanagement",
"marketing",
"pointofsale",
"general",
"finance",
"questback",
"ocr",
"monitoring",
"db",
"sageaccounting",
"sagepayroll",
"native",
"fsa",
"helpdesk",
"ecommerce",
"collaboration",
"conferencing",
"payment",
"billing",
"expense",
"employee",
"scheduling",
"crm",
"analytics",
"erp"
]
Below are example cURL commands and examples of successful responses for each of the Hub API calls.
GET /hubs
Retrieve all available hubs.
Below is an example cURL command of the GET /hubs API call and successful response. This call will return all of the Hub names and keys associated with each Hub. Make sure your quotes are straight in your cURL command.
curl -X GET https://api.cloud-elements.com/elements/api-v2/hubs
Example of Successful Response.
[
{
"id": 14,
"name": "Help Desk Beta",
"key": "helpdesk",
"description": "Help Desk Services"
},
{
"id": 12,
"name": "Marketing Beta",
"key": "marketing",
"description": "Marketing Element Hub"
},
{
"id": 1,
"name": "Messaging",
"key": "messaging",
"description": "Messaging type includes Emails, SMS"
},
{
"id": 11,
"name": "CRM",
"key": "crm",
"description": "CRM Element Hub"
},
{
"id": 4,
"name": "Documents",
"key": "documents",
"description": "Document Hub includes GoogleDrive, Dropbox, Box.com, OneDrive, Sharepoint, and Amazon s3"
}
]
GET /hubs/keys
Retrieve all available hub keys.
Below is an example cURL command of the GET /hubs/keys API call and successful response. This call will return all of the Hub keys. Make sure your quotes are straight in your cURL command.
curl -X GET https://api.cloud-elements.com/elements/api-v2/hubs/keys
Example of Successful Response:
[
"messaging",
"documents",
"esignature",
"idmanagement",
"marketing",
"pointofsale",
"general",
"finance",
"questback",
"ocr",
"monitoring",
"db",
"sageaccounting",
"sagepayroll",
"native",
"fsa",
"helpdesk",
"ecommerce",
"collaboration",
"conferencing",
"payment",
"billing",
"expense",
"employee",
"scheduling",
"crm",
"analytics",
"erp"
]
GET /hubs/{key}
Retrieve a specific hub associated with the hub key.
Below is an example cURL command of the GET /hubs/{keys} API call and successful response. This call will return all of the Hub information associated with that key. Make sure your quotes are straight in your cURL command.
curl -X GET https://api.cloud-elements.com/elements/api-v2/hubs/documents
Example of Successful Response:
{
"id":4,
"name":"Cloud Storage & Documents",
"key":"documents",
"description":"Document Hub includes GoogleDrive, Dropbox, Box.com, OneDrive, Sharepoint, and Amazon s3",
"videoLink":"//player.vimeo.com/video/109624971?title=0&byline=0&portrait=0&autoplay=1",
"active":true
}
GET /hubs/{key}/elements
Retrieve all of the elements that belong to the specified hub.
Below is an example cURL command of the GET /hubs/{keys}/elements API call and successful response. This call will return all of the Elements associated with a particular Hub. Make sure your quotes are straight in your cURL command.
curl -X GET https://api.cloud-elements.com/elements/api-v2/hubs/documents/elements
Example Successful Response. The response has been truncated:
[
{
"id": 16,
"name": "Amazon S3",
"key": "amazons3",
"description": "Amazon S3 is storage for the Internet. It is designed to make web-scale computing easier for developers.",
"image": "elements/provider_amazon_aws.png",
"active": true,
"deleted": false,
"typeOauth": false,
"trialAccount": false,
"existingAccountDescription": "Give Cloud Elements access to your existing <br> Amazon S3 account</br><spann class="buttonDescription">Enter your credentials and details for your <b>Amazon S3 Account</b></span>",
"configDescription": "If you do not have an Amazon AWS account, you can create one at <a href="http://aws.amazon.com" target="_blank">Amazon AWS Signup</a>",
"signupURL": "http://aws.amazon.com"
},
{
"id": 22,
"name": "Box",
"key": "box",
"description": "Box offers secure, scalable, content-sharing that both users and IT love and adopt. Box is a simple and affordable solution to manage documents, media and all your content online. Share files as a link. Sync files on the desktop. It's file sharing, reinvented.",
"image": "elements/provider_box.png",
"active": true,
"deleted": false,
"typeOauth": true,
"trialAccount": false,
"existingAccountDescription": "Give your application access to your existing <br> Box account</br><span class="buttonDescription">Enter your credentials and details for your <b>Box Account</b></span>",
"configDescription": "If you do not have an Box.net account, you can create one at <a href="http://www.box.com" target="_blank">Box.Net Signup</a>",
"elementProvisionType": "OAUTH_TEMPLATE"
},
{
"id": 14,
"name": "Dropbox",
"key": "dropbox",
"description": "One place for all your stuff, wherever you are. Dropbox is a free service that lets you bring your photos, docs, and videos anywhere and share them easily. Anything you add to Dropbox will automatically show up on all your computers, phones and even the Dropbox website.",
"image": "elements/provider_dropbox.png",
"active": true,
"deleted": false,
"typeOauth": true,
"trialAccount": false,
"existingAccountDescription": "Give your application access to your existing <br> Dropbox account</br><span class="buttonDescription">Enter your credentials and details for your <b>Dropbox Account</b></span>",
"configDescription": "If you do not have an Dropbox account, you can create one at <a href="http://www.dropbox.com" target="_blank">Dropbox Signup</a>",
"signupURL": "http://www.dropbox.com",
"elementProvisionType": "OAUTH_TEMPLATE"
},
...
]
If you need any support integrating our APIs, please let us know. You can email or give us a call at +1.866.830.3456. We will do our best to get back to you within 24 hours. Your success is our success.