Introduction

Welcome to the reference for the SSIMWAVE Livemonitor REST API!

Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. We currently provide our documentation in the form of an OpenAPI 3.0 document.

If you’re interested in integrating your app or software platform with SSIMWAVE, you’ll need to contact us at sales@ssimwave.com

The base address of the API is https://${LIVEMONITOR HOST}/api/v1. The API provides a set of endpoints, each with its own unique path. To access data through the API, an application must obtain an access token and permission to access the data.

Note: By using this API, you accept the SSIMWAVE Terms of Service.

Authentication

The Livemonitor authentication server supports the Resource Owner Credential Grant flow of the OAuth2 specification to exchange a user’s SSIMWAVE username and password for an access token.

A POST request is made to /auth/token with grant_type set to password, and the Authorization header set with the client_id and client_secret.

curl GET "http://${Livemonitor host}/" -H "Authorization: Bearer ${token}"

This token must be provided in requests made to the Livemonitor API for authorization.The POST /auth/token endpoint accepts requests containing form-encoded (default) or JSON payloads.

Request Example(form-encoded)

curl -k -X POST "https://${AUTH_HOST}/auth/token" -d grant_type=password -d username=test -d password=test

Request Example (JSON)

curl -k -X POST "https://${AUTH_HOST}/auth/token" -H "Content-Type: application/json" -d '{"grant_type":"password","username":"test","password":"test"}'

Response Example

{  
    "token_type": "Bearer",
    "expires_in": 3600,
    "access_token": "eyJhbGciOiJIUJ9.eyJ1c2VyIjp7Im9pZ...G1pbiIsImRpcL2F1dGgifQ.kJH_sZTgdx9YeK43ms9BCB7870",
    "refresh_token":"eyJwcm90ZWN0ZWQiOipSmthWElpTENKc...STQycUJtMlFIU3ZUbHBKc1Z6WmcifQ=="
}

NOTE: You should only make this call once and store the returned token securely. You should not make this call high-frequency interval.