Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
| ezeio2:apiref:start [2022-07-15 19:55] – andreh | ezeio2:apiref:start [2026-06-18 21:16] (current) – andreh | ||
|---|---|---|---|
| Line 11: | Line 11: | ||
| 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 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. | ||
| + | |||
| + | Alternatively, | ||
| All API calls require HTTPS using TLS v1.2 or TLS v1.3. Calls via unencrypted HTTP are not allowed. | All API calls require HTTPS using TLS v1.2 or TLS v1.3. Calls via unencrypted HTTP are not allowed. | ||
| Line 37: | Line 39: | ||
| === Example code === | === Example code === | ||
| + | This example shows how to call the " | ||
| + | <code php> | ||
| + | curl -H " | ||
| + | </ | ||
| + | |||
| This example shows how to call the " | This example shows how to call the " | ||
| Line 56: | Line 63: | ||
| ); | ); | ||
| - | // Request a websocket key and metadata using cURL | + | // Set up cURL |
| $ch = curl_init(); | $ch = curl_init(); | ||
| curl_setopt($ch, | curl_setopt($ch, | ||
| Line 80: | Line 87: | ||
| // Show what we received | // Show what we received | ||
| print_r($json); | print_r($json); | ||
| + | </ | ||
| + | |||
| + | Below is a minimal example fetching current status using Python | ||
| + | |||
| + | <code python ezeioAPIexample.py> | ||
| + | import requests | ||
| + | from requests.auth import HTTPDigestAuth | ||
| + | from pprint import pprint # Just used to format the output | ||
| + | |||
| + | # API credentials from eze.io -> Groups Settings -> Manage API Keys | ||
| + | apikeyid = ' | ||
| + | apikey = ' | ||
| + | |||
| + | # API endpoint and request - see doc.eze.io | ||
| + | apiurl = ' | ||
| + | |||
| + | # Send request | ||
| + | r = requests.get(apiurl, | ||
| + | |||
| + | # Convert response to a dictionary | ||
| + | data = r.json() | ||
| + | |||
| + | # Dump whole dictionary to screen | ||
| + | pprint(data) | ||
| + | |||
| + | # Print the value of field 1 | ||
| + | print(data[' | ||
| </ | </ | ||