ezeio2:apiref:start

API endpoint : https://api.eze.io/v1

Credentials

API credentials must be created for the account. The credentials consists of an ID number and a 24 character key. Please keep the API credentials secret.

All API calls require authentication using Digest Auth (RFC 2617). The API ID number shall be used as the Digest Auth Username, and the API key shall be used as the Password.

All API calls require HTTPS using TLS v1.2 or TLS v1.3. Calls via unencrypted HTTP are not allowed.

All API calls return data encoded in JSON. The response include the time of the request (reqtime) and a result code in (status). If the call was successful, the status will be “OK”. If there was an error, status will be a string detailing the error.

This section contains example code in PHP, however most development frameworks and languages can be used to interface to the ezeio API. There is no dependency on any special language or operating system.

Please note that using the API requires knowledge in programming and standard web technologies. eze System is happy to support with specifics related to the API, but we can't teach programming.

Available API functions

Example code

This example shows how to call the “syslog” API endpoint using PHP.

ezeioAPIexample.php
<?php
    define("APIURI", "https://api.eze.io/v1/syslog");
 
    // API keyID and key needs to be set up in eze.io under Groups->API.
    define("APIKeyID", "00000");
    define("APIKey", "12345abcde12345abcde12345abcdeff");
 
    $params = array(
        "ABC000",               // ezeio serial
        "from=2021-11-01",      // start of data
        "to=2021-11-10",        // end of data
        "fields=1,12,cRSSI",    // list of fields we care about
        "1h",                   // 1h interval data..
        "mean"                  // ..as averages
    );
 
    // Request a websocket key and metadata using cURL
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, APIURI."/".implode("/", $params));
 
    // All API calls use Digest AUTH
    curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);        
    curl_setopt($ch, CURLOPT_USERPWD, APIKeyID.":".APIKey);
 
    // Set a 5s timeout, return any received data, ignore ssl errors
    curl_setopt($ch, CURLOPT_TIMEOUT, 5);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE); 
    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
 
    // Execute the cURL request
    $response = curl_exec($ch);
    if(curl_errno($ch))         // if there's an error..
        die(curl_error($ch));   // quit and show what the problem is
    curl_close($ch);
 
    // Decode the json reply into an associative array
    $json = json_decode( $response, TRUE );                     
 
    // Show what we received
    print_r($json);
  • ezeio2/apiref/start.txt
  • Last modified: 2021-11-18 22:03
  • by andreh