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 [2021-11-18 22:03] – andreh | ezeio2:apiref:start [2022-08-11 17:17] (current) – [Version 1 API] andreh | ||
---|---|---|---|
Line 27: | Line 27: | ||
=== Available API functions === | === Available API functions === | ||
{{indexmenu> | {{indexmenu> | ||
+ | |||
+ | === API fair use === | ||
+ | The API functionality is a shared resource, and as such requires 'good behavior' | ||
+ | |||
+ | The API also implements flood control counters to limit excessive calls as follows; | ||
+ | * Per 60 seconds : 100 API calls per key | ||
+ | * Per 24 hours : 50000 API calls per key | ||
+ | If these limits are exceeded, an error is returned. The counters are automatically reset at the end of the interval. | ||
=== Example code === | === Example code === | ||
Line 48: | Line 56: | ||
); | ); | ||
- | // Request a websocket key and metadata using cURL | + | // Set up cURL |
$ch = curl_init(); | $ch = curl_init(); | ||
curl_setopt($ch, | curl_setopt($ch, | ||
Line 72: | Line 80: | ||
// 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[' | ||
</ | </ |