The VibCloud API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

The VibCloud API doesn't support any updates. You can only retrieve data.

URL: provided on request

Authentication

The VibCloud API uses API keys to authenticate requests. Those keys are provided by the administrator.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Authentication to the API is performed via HTTP Basic Auth. Provide your API key as the basic auth username value. You do not need to provide a password.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Parameters

StructureID - [string, max 100 characters] this is the structure code (or part of structure code) assigned to the particular equipment. This parameter can take multiple input, make sure they are comma “,” separated;
DateFrom - [date, YYYY-MM-DD] date filter for the returned data (measured values), it specifies from which point to start;
DateTo - [date, YYYY-MM-DD] date filter for the returned data (measured values), it specifies to the (final) point in time;
CountNo - [integer, 1-1000] counter of how many measurements should be returned. Use a number between 1 and 1000;

All parameters are optional. If no parameter is specified call will return all data from the database.

Results are sorted by Structure Code ASC and by Collected On DESC.

Errors

VibCloud uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with VibCloud’s servers.

Example

API Call: https://vibcloudapiXXX.azurewebsites.net/api/clientvvdata?StructureID=DM-007,DU-008&CountNo=1

Method: GET

HTTP Headers: {"api-key", "the_api_key"}

Returns JSON Array:

[

{

"LocalStructureID": 123456,

"StructureCode": "DM-007",

"StructureDesc": "Tower Water Pump",

"MeasuringPoint": "Motor DE Horizontal\n",

"RMSAcceleration": 0.16660672426223755,

"AUnit": "g",

"AccInvestigation": null,

"AccWarning": null,

"AccAlarm": null,

"RMSVelocity": 0.0410086065530777,

"VUnit": "in/s",

"VelInvestigation": 0.23,

"VelWarning": 0.25,

"VelAlarm": 0.4,

"RMSDemodulation": 0.046995293349027634,

"DUnit": "du_g",

"DemInvestigation": null,

"DemWarning": null,

"DemAlarm": null,

"CollectedOn": "2021-07-15 15:17:29"

},

{

"LocalStructureID": 654123,

"StructureCode": "DU-008",

"StructureDesc": "Primary Chilled Water Pump",

"MeasuringPoint": "Motor DE Horizontal\r\n",

"RMSAcceleration": 0.24921463429927826,