FOR DEVELOPERS

Empowering rapid development and dependable results.

A scalable, secure and intuitive platform to, Reduces costs, Build and deploy faster.

Request a Demo Account

Manage every aspect of your assets

Add, track, and manage your devices on a platform proven to deliver the data you need so you can focus on developing your product.

Trackable Management

Register and manage your trackable entities using standard REST actions. Common vehicle attributes are part of our standard domain model but can be extended with custom attributes per trackable type.

Additionally, every Trackable is represented as an Asset linked to a Device. Advanced use cases allow for finer grained control over these associates, enabling specialized lifecycle management of Devices and Assets independently.

Telemetry Ingestion

Telemetry data can be delivered per-payload or in bulk via a friendly RESTful interface, with more methods yet to come (UDP, MQTT, etc.). NSpire offers a rich vehicle-centric JSON schema to organize device telemetry, but also supports open-ended custom structures.

All payloads with valid Location Segments (GPS coordinates) are automatically enriched with geography details, preventing any need to associate with RGEO providers. Latitude and Longitude becomes state, city, and address.

Stating

Not only can telemetry be retrieved in raw form, all telemetry data contributes to various stating engines to keep track of useful conditions for a given Trackable. Information like movement state is immediately derived from recent payloads, as well as aggregated information like a Virtual Odometer.

You will be able to define custom state definitions for your own telemetry data soon.

Geozones

Create and manage geozones with simple and complex shapes. GPS coordinates are used to determine geozone conditions, with all entries and exits registering special events. Geozones can be Trackable-specific or account wide, with extra analytics available for geozone details.

Trips

Long, continuous streams of data can be difficult to process into meaningful spans. We can detect and extract trip starting and ending conditions and provide a convenient interface for analyzing a trackable’s journey.

Alerting

Sense when simple or advanced conditions change or are met. Alerts can be defined for a variety of scopes, or even only measured during certain times of the day or week.

Some examples might be: When a particular speed or battery level is reached, when a member of a particular group of trackables leaves a designated area at an odd hour of the day, or when a device has failed to report in a specified interval.

Alerts can be delivered immediately via email, SMS, webhook, or retrieved later through interactive queries or via the data warehouse.

Web Hooks

You have the power to direct any event or payload where you need it to go. Webhooks can be configured with various scopes (or account wide) to match the needs of your environment. Diagnostic data per individual webhook is available to support troubleshooting and development scenarios.

Data Sharing

Bring your Snowflake account and get directly connected to the entirety of your data universe. All enriched telemetry and state information is warehoused in the NSpire platform and therefore made directly available to you for any data science or analytical purpose.

Real-time Asset Data

In addition to our suggested vehicle-centric data schemes, telemetry and event data can be enriched with your unique attributes and values. Our reporting format allows you to send and store custom data structures to fit your own IOT use-cases.

Examples

Use the code examples below to see how NSpire can quicken your development process.

PaaS Quick Usage Guide Authentication

Before using any of the NSpire APIs, you will need a valid, unexpired JWT (https://jwt.io/) token.

To create an authentication request, you will need at a minimum:

Example

curl 'https://api.nspireplatform.io/identity/token' \
-H 'X-Nspire-AppToken: abcd1234-ab12-cd34-1234-abcd1234abcd' \
-H 'Authorization: Basic abcdABCDabcdABCDabcdABCDabcdABCDabcdABCDabcdABCDabcdABC='

Response

{
  "token": "eyJhbGciOiJIUzI1NiJ9.eyJSb2xlIjoiZmFrZWFkbWluIiwibnM6dSI6IjY3ODk2Nzg5Njc4OTY3ODkiLCJVc2VybmFtZSI6ImZha2V1c2VyIiwiaXNzIjoic3BpcmVvbi5jb20iLCJuczphcHAiOiJhYmNkMTIzNC1hYjEyLWNkMzQtMTIzNC1hYmNkMTIzNGFiY2QiLCJleHAiOjE2NzA0MDYwOTksImlhdCI6MTY3MDQwNjA5OSwibnM6YiI6InBhYXMiLCJuczphIjoiMTIzNDEyMzQxMjM0MTIzNCJ9.dodIojTSLP8_nnw3SokmBZi8QVo4lmr0-GY5UmRbeFo",
  "scope": "ACCOUNT_USER_SCOPE",
  "expiresOn": "2022-12-08T09:38:34Z",
  "refreshBy": "2022-12-08T09:37:34Z",
  "refreshInSeconds": 86340
}

The token can then be used for subsequent API calls.

export AUTHHEADER='Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJSb2xlIjoiZmFrZWFkbWluIiwibnM6dSI6IjY3ODk2Nzg5Njc4OTY3ODkiLCJVc2VybmFtZSI6ImZha2V1c2VyIiwiaXNzIjoic3BpcmVvbi5jb20iLCJuczphcHAiOiJhYmNkMTIzNC1hYjEyLWNkMzQtMTIzNC1hYmNkMTIzNGFiY2QiLCJleHAiOjE2NzA0MDYwOTksImlhdCI6MTY3MDQwNjA5OSwibnM6YiI6InBhYXMiLCJuczphIjoiMTIzNDEyMzQxMjM0MTIzNCJ9.dodIojTSLP8_nnw3SokmBZi8QVo4lmr0-GY5UmRbeFo'

Create Trackable

Your first trackable can be created with ease:

Example

curl -X 'POST' 'https://api.nspireplatform.io/v1/trackables' \
  -H $AUTHHEADER \
  -H 'Content-Type: application/json' \
  -d '{
  "asset": {
  "name": "First Trackable",
  "description": "My first trackable",
  "make": "Ford",
  "model": "F-150",
  "year": 2022
  }
}'

Response

{
"id": "1670407144723YZ8MR83",
"asset": {
"id": "1670407144723YZ8MR83",
"active": true,
"name": "First Trackable",
"description": "My first trackable",
"type": null,
"make": "Ford",
"model": "F-150",
"year": 2022,
...
},
"device": {
"id": "1670407144738X167D27",
"active": true,
"serialNumber": "cb57f158-0165-4e13-ba34-ae1f26a41649",
"type": "paas",
...
  }
}

Send Telemetry

Use the rich telemetry schema to capture vehicle details. For example, to provide movement data, you may use:

Example

curl -X 'POST' 'https://telemetry.nspireplatform.io/v1/telemetryreports' \
-H $AUTHHEADER \
-H 'Content-Type: application/json' \
-d '{
	"reports": [
		{
			"id": "6302bbb3-4287-4b82-8457-8618981ee70e",
			"eventTime": "2022-12-07T10:30:49.012Z",
			"device": {
				"assetId": "1670407144723YZ8MR83",
				"softwareVersion": "1.0.0"
			},
			"telemetryEvent": {
				"locationDetail": {
					"gps": {
						"gpsFixQuality": "GOOD"
					},
					"location": {
						"lat": "33.684125",
						"lng": "-117.847920"
					}
				},
				"type": "MotionEvent",
				"eventType": "MOVEMENT_PERIODIC",
				"movement": {
					"heading": 0,
					"speedKPH": 20
				},
				"odometer": {
					"odometer": 1,
					"odometerSource": "COMPUTED"
				}
			},
			"telemetryData": []
		}
	]
}'

Response

{
	"statusCode":202,
	"detailMessage":"ACCEPTED",
	"errorDetails":[]
}

API References

NSpire’s powerful APIs equip you with the tools to build fast on our proven platform.

Telemetry

Data delivered per payload or bulk via restful interface. Rich vehicle centric JSON schema to organize device telemetry and supports open ended custom structures.

Learn more

Adminstrative

Manage all your assets in a single interface, add users and set permissions along with your usage and billing details.

Learn more

Webhooks

Direct any event or payload where you need it to go. Custom configuration available to suit your environment needs. Diagnostic data per individual webhook is available to support troubleshooting and development scenarios.

Learn more

Usage of the API will require a demo account. Request your demo account below, and someone will reach out with further instructions shortly!

Request a Demo Account

Inspired Yet? Bring your ideas to life.

Talk to an Expert
Scroll to Top