1NCE IoT Integrator API
Integrate Devices and Clouds
1NCE IoT Integrator API is one of 22 APIs that 1NCE publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 2 JSON Schema definitions.
Tagged areas include IoT Integrator. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.
This API exposes 35 operations across 29 paths, and defines 63 schemas. It is described by OpenAPI 3.0.1, at version v2.1.1.
Requests are made against a single base URL, https://api.1nce.com/management-api.
35 operations
29 paths
63 schemas
3 DELETE13 GET3 PATCH16 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
1NCE IoT Integrator API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (BasicAuthentication).
BasicAuthentication— Basic authentication used for obtaining the Bearer Authentication Token. The Bearer Token can then be used to make any further API calls towards the 1NCE API.
Paths & Operations 35
Across 29 paths, the API surfaces 35 operations — 3 DELETE, 13 GET, 3 PATCH, 16 POST. Each is listed below with its method, path, parameters, and response codes.
IoT Integrator 35
Integrate Devices and Clouds
GET
/v1/integrate/devices/endpoints
Get device endpoints
GET
/v1/integrate/devices/endpoints/{protocol}
Get single device endpoint
PATCH
/v1/integrate/devices/endpoints/{protocol}
Patch single device endpoint
GET
/v1/integrate/devices/actions/requestsdeprecated
Get device action requests
GET
/v1/integrate/devices/actions/requests/active
Get active device action requests
GET
/v1/integrate/devices/actions/requests/archived
Get archived device action requests
DELETE
/v1/integrate/devices/{deviceId}/actions/requests
Cancel all device action requests
DELETE
/v1/integrate/devices/actions/requests/{requestId}
Cancel single device action request
GET
/v1/integrate/devices/actions/requests/{requestId}
Get single device action request
POST
/v1/integrate/devices/{deviceId}/presharedkey
Create Pre-Shared Device Key
GET
/v1/integrate/devices/presharedkey/jobs
Pre-Shared Devices Keys Import Job Status
POST
/v1/integrate/devices/presharedkey/jobs
Import Pre-Shared Devices Keys
POST
/v1/integrate/devices/{deviceId}/psk
Create Pre-Shared Device Key
GET
/v1/integrate/devices/{deviceId}/psk/{protocol}
Get Pre-Shared Device Key
GET
/v1/integrate/devices/psk/jobs
Pre-Shared Devices Keys Import Job Status
POST
/v1/integrate/devices/psk/jobs
Import Pre-Shared Devices Keys
POST
/v1/integrate/devices/{deviceId}/actions/LWM2M
Create Action Request On Specific LwM2M Device.
POST
/v1/integrate/devices/actions/LWM2M
Create Action Requests for LwM2M Devices.
POST
/v1/integrate/devices/{deviceId}/actions/COAP
Create Action Request On Specific CoAP Device.
POST
/v1/integrate/devices/actions/COAP
Create Action Requests for CoAP Devices.
POST
/v1/integrate/devices/{deviceId}/actions/UDP
Create Action Request On Specific UDP Device.
POST
/v1/integrate/devices/actions/UDP
Create Action Requests for UDP Devices.
GET
/v1/integrate/clouds/aws/parameters
Get CloudFormation Parameters
POST
/v1/integrate/clouds/aws/{integrationId}/restart
Restart AWS Integration
POST
/v1/integrate/clouds/aws/{integrationId}/test
Test AWS Integration
POST
/v1/integrate/clouds/aws
Create AWS Integration
DELETE
/v1/integrate/clouds/{integrationId}
Delete Integration
GET
/v1/integrate/clouds/{integrationId}
Get Customer Integration
PATCH
/v1/integrate/clouds/{integrationId}
Patch Customer Integration
GET
/v1/integrate/clouds
Get All Customer Integrations
GET
/v1/integrate/clouds/eventTypes
Get Integration Event Types
POST
/v1/integrate/clouds/webhooks
Create Webhook Integration
PATCH
/v1/integrate/clouds/webhooks/{integrationId}
Patch Customer Webhook Integration
POST
/v1/integrate/clouds/webhooks/{integrationId}/restart
Restart Webhook Integration
POST
/v1/integrate/clouds/webhooks/{integrationId}/test
Test Webhook Integration
Schemas 63
The contract defines 63 schemas that model the data the API accepts and returns. The most detailed are getResponseschema_11 (15 properties), patchResponseschema_1 (13 properties), getAllResponseschema_1_items_inner (12 properties), getResponseschema_1 (12 properties). Each schema is shown below with its type and property counts.
postResponseschema_5
object
Post Webhook integration response
10 properties
10 required
bulkPostschema_2
object
Bulk Post UDP device action.
5 properties
4 required
postschema_6
object
Post AWS integration request
3 properties
2 required
patchschema
object
Patch status for device endpoint request.
2 properties
1 required
getResponseschema_2_items_inner
object
7 properties
7 required
getResponseschema_settings_inner
object
3 properties
2 required
postschema_3
object
Post UDP device action.
4 properties
3 required
getAllResponseschema_items_inner
object
6 properties
5 required
patchschema_3
object
Patch integration request
4 properties
patchResponseschema
object
Response to the patch device endpoints request.
7 properties
6 required
getAllResponseschema_5_items_inner
object
9 properties
8 required
postschema_inner
object
4 properties
3 required
patchschema_settings_inner
object
2 properties
2 required
getArchivedResponseschema_items_inner
object
12 properties
8 required
postResponseschema_3
object
Post AWS integration test response
2 properties
2 required
getArchivedResponseschema
object
Response to the request to get archived device action requests.
3 properties
3 required
postschema_2
object
Post CoAP device action.
7 properties
3 required
postResponseschema_6_integration
object
8 properties
7 required
postResponseschema_2
object
Post AWS integration restart response
3 properties
3 required
bulkPostResponseschema
object
Post device action response.
3 properties
3 required
badRequestResponse
object
An API error response in case of an HTTP Bad Request.
3 properties
bulkPostschema
object
Bulk Post LwM2M device action.
6 properties
3 required
unauthorizedRequestResponse
object
An API error response in case of an HTTP Unauthorized Request.
3 properties
postschema
array
Import of Pre-Shared Keys for multiple devices.
getEventTypesResponseschema_eventTypes_inner
object
4 properties
4 required
postResponseschema_4_eventTypes_inner
object
2 properties
2 required
patchResponseschema_2
object
Patch Webhook integration response
10 properties
10 required
postschema_1
object
Post LwM2M device action.
5 properties
2 required
deleteAllResponseschema
array
Response to the request to cancel all device action requests.
notFoundResponse
object
An API error response when a resource is Not Found.
3 properties
postResponseschema
object
Post device action response.
2 properties
2 required
getResponseschema_1
object
Response to the request to get device action request.
12 properties
8 required
patchResponseschema_1
object
Patch integration response
13 properties
8 required
getCloudFormationParameters_awsIntegration_inner
object
2 properties
2 required
getAllResponseschema_1_items_inner
object
12 properties
8 required
conflictResponse
object
An API error response when a conflict is found.
3 properties
getAllResponseschema_1
object
Response to the request to get device action requests.
3 properties
3 required
postResponseschema_7
object
Post Webhook integration test response
2 properties
2 required
getResponseschema_2
object
Get status of device PreSharedKey import job.
3 properties
3 required
getResponseschema_11
object
Get Integration response
15 properties
8 required
postResponseschema_6
object
Post Webhook integration restart response
3 properties
3 required
bulkPostschema_1
object
Bulk Post CoAP device action.
8 properties
4 required
postschema_6_eventTypes_inner
object
2 properties
1 required
bulkPostResponseschema_acceptedRequests_inner
object
2 properties
patchschema_4
object
Patch Webhook integration request
4 properties
getEventTypesResponseschema
object
Get all event types response
1 property
1 required
postschema_7
object
Post Webhook integration request
5 properties
4 required
getActiveResponseschema_items_inner
object
12 properties
8 required
getResponseschema
object
Response to the get device endpoints request.
7 properties
5 required
getCloudFormationParameters
object
Get the CloudFormation parameters currently configured.
1 property
1 required
postPreSharedKeyschema
object
Post a pre-shared key for a specific device.
3 properties
2 required
getAllResponseschema
object
Response to the get device endpoints request.
3 properties
3 required
deleteResponseschema
object
Response to the request to cancel device action request.
2 properties
2 required
postResponseschema_2_integration_eventTypes_inner
object
2 properties
1 required
deleteAllResponseschema_inner
object
2 properties
2 required
serverErrorResponse
object
An API error response in case of a Server Side Error.
2 properties
postPreSharedKeyResponseschema
object
Post pre-shared key response.
7 properties
7 required
getActiveResponseschema
object
Response to the request to get active device action requests.
3 properties
3 required
postResponseschema_4
object
Post AWS integration response
9 properties
9 required
patchschema_3_eventTypes_inner
object
2 properties
1 required
getAllResponseschema_5
object
Get a list of Integrations
3 properties
3 required
forbiddenResponse
object
An API error response in case of an HTTP Forbidden Request.
3 properties
postResponseschema_2_integration
object
8 properties
7 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from 1NCE 12
Other APIs 1NCE publishes across the network.
1NCE Administration Logs API
1NCE Agreements API
1NCE Bearer Authorization API
1NCE Connectivity API
1NCE Device Inspector API
1NCE Device Locator API
1NCE Devices API
1NCE General SIMs API
1NCE Optimizer API
1NCE Orders API
1NCE Plugin system API
1NCE Products API
#IoT Integrator