Integrations Actions

https://api.losant.com/applications/APPLICATION_ID/integrations

Below are the various requests that can be performed against the Integrations resource, as well as the expected parameters and the potential responses.

Get

Returns the integrations for an application

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/integrations

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, integrations.*, or integrations.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: name, id, creationDate, integrationType, lastUpdated	name	sortField=name
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	asc	sortDirection=asc
page	N	Which page of results to return	0	page=0
perPage	N	How many items to return per page	100	perPage=10
filterField	N	Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name, integrationType		filterField=integrationType
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=my*integration

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/applications/APPLICATION_ID/integrations

Successful Responses

Code	Type	Description
200	Integrations	Collection of integrations

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Post

Create a new integration for an application

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/integrations

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, integrations.*, or integrations.post.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Integration Post schema. For example, the following would be a valid body for this request:

{
  "name": "Example Integrations",
  "integrationType": "mqtt",
  "topics": [
    "myTopic"
  ],
  "mqttConfig": {
    "clientId": "exampleClientId",
    "username": "exampleUsername",
    "password": "examplePassword",
    "port": 8883,
    "protocol": "mqtts",
    "host": "broker.example.com"
  }
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"name":"Example Integrations","integrationType":"mqtt","topics":["myTopic"],"mqttConfig":{"clientId":"exampleClientId","username":"exampleUsername","password":"examplePassword","port":8883,"protocol":"mqtts","host":"broker.example.com"}}' \
    https://api.losant.com/applications/APPLICATION_ID/integrations

Successful Responses

Code	Type	Description
201	Integration	Successfully created integration

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Schemas

Error

Schema for errors returned by the API

Error Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
type:{} 1 key
▶
message:{} 1 key
▶
validationErrors:{} 2 keys

Error Example

▶
(root){} 2 keys
type:"NotFound"
message:"Application was not found"

Integration

Schema for a single Integration

Integration Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 17 keys
▶
id:{} 2 keys
▶
integrationId:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
name:{} 3 keys
▶
credentialName:{} 3 keys
▶
integrationType:{} 2 keys
▶
enabled:{} 1 key
▶
topics:{} 3 keys
▶
azureEventHubConfig:{} 4 keys
▶
googlePubSubConfig:{} 3 keys
▶
mqttConfig:{} 4 keys
▶
particleConfig:{} 4 keys
▶
sqsConfig:{} 4 keys
▶
websocketConfig:{} 4 keys
▶
status:{} 2 keys

Integration Example

▶
(root){} 11 keys
id:"58ec07f20c747f65243d0d76"
integrationId:"58ec07f20c747f65243d0d76"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
name:"Example Integrations"
integrationType:"mqtt"
enabled:true
▶
topics:[] 1 item
▶
mqttConfig:{} 6 keys
▶
status:{} 3 keys

Integration Post

Schema for the body of an Integration creation request

Integration Post Schema

▶
(root){} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 11 keys
▶
name:{} 3 keys
▶
integrationType:{} 2 keys
▶
enabled:{} 1 key
▶
credentialName:{} 3 keys
▶
topics:{} 3 keys
▶
azureEventHubConfig:{} 4 keys
▶
googlePubSubConfig:{} 3 keys
▶
mqttConfig:{} 4 keys
▶
particleConfig:{} 4 keys
▶
sqsConfig:{} 4 keys
▶
websocketConfig:{} 4 keys
additionalProperties:false
▶
required:[] 2 items

Integration Post Example

▶
(root){} 4 keys
name:"Example Integrations"
integrationType:"mqtt"
▶
topics:[] 1 item
▶
mqttConfig:{} 6 keys

Integrations

Schema for a collection of Integrations

Integrations Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 10 keys
▶
items:{} 2 keys
▶
count:{} 1 key
▶
totalCount:{} 1 key
▶
perPage:{} 1 key
▶
page:{} 1 key
▶
filter:{} 1 key
▶
filterField:{} 1 key
▶
sortField:{} 1 key
▶
sortDirection:{} 2 keys
▶
applicationId:{} 2 keys

Integrations Example

▶
(root){} 8 keys
▶
items:[] 1 item
count:1
totalCount:4
perPage:1
page:0
sortField:"name"
sortDirection:"asc"
applicationId:"575ec8687ae143cd83dc4a97"