Compare commits

...

6 commits

Author SHA1 Message Date
Brent Rubell
47d2ddb964
Merge pull request #63 from adafruit/issue-50-update-key-images
Issue-50-update-key-images
2024-10-24 09:06:18 -05:00
Brent Rubell
47837d08b4
Merge pull request #61 from adafruit/tyeth/issue58
Datums - Update parameter tables for datum endpoints
2024-10-24 09:05:26 -05:00
tyeth
028fe6a4aa Shrink excessively large menu image + mention small screen 2024-10-24 11:52:00 +01:00
tyeth
3995601e32 Update key location text 2024-10-24 09:45:29 +01:00
tyeth
cb071d9942 Update images showing AIO Key - fixes #50 2024-10-24 09:42:23 +01:00
tyeth
2f8db6bc91 Datums - Update parameter tables for datum endpoints
Adds instructions about submitting multiple data points in one operation.
Swaps the parameter name from datum to "Request Body" for single data endpoints.
Fixes #58
2024-10-24 09:24:33 +01:00
7 changed files with 10 additions and 7 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.6 KiB

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 36 KiB

View file

@ -1,10 +1,10 @@
# Authentication
Your Adafruit IO Key is used to restrict or grant access to your data. The key is unique and covers every use of the Adafruit IO API for your account. You can access your key any dashboard by clicking on the golden key icon:
Your Adafruit IO Key is used to restrict or grant access to your data. The key is unique and covers every use of the Adafruit IO API for your account. You can access your key on any IO page by clicking on the golden key icon:
<%= image_tag "images/authentication/aio-key-dashboard-link.png" %>
Or by clicking on the "View AIO Key" link in the sidebar while you're visiting Adafruit IO.
Or by clicking on the "View Adafruit IO Key" link in the small screen drop-down menu while you're visiting Adafruit IO.
<%= image_tag "images/authentication/aio-key-sidebar-link.png" %>

View file

@ -88,4 +88,4 @@ atob("eyJzb21ldGhpbmciOiJoZXJlIn0=")
```
<% end %>
This solution is also ideal if you want to store or send binary data with Adafruit IO. You won't get to see any pretty charts, but your data will remain exactly the way you left it.
This solution is also ideal if you want to store or send binary data with Adafruit IO. You won't get to see any pretty charts (although we do display base64 encoded images), but your data will remain exactly the way you left it.

View file

@ -6,7 +6,7 @@ You can create, read, update, or delete data records. Every **CREATE**, **UPDATE
Data points belong to feeds, so every Data API call starts with a Feed URL.
Note that there are endpoints for submitting multiple data points to a feed, and multiple feed values to a group, see **feeds/{feed_key}/batch** and **groups/{groupname}/data** endpoints.
## Create Data
@ -76,7 +76,7 @@ feed_key | string | true | a valid feed key
Parameter | Type | Required | Description
--------- | ------- | --------- | -----------------------
datum | object | true | Data record including a `value` field (required) and optionally including: `lat`, `lon`, `ele` (latitude, longitude, and elevation values), and `created_at` (a date/time string).
<b>Request Body</b> | object | true | Data record (datum) including a `value` field (required) and optionally including: `lat`, `lon`, `ele` (latitude, longitude, and elevation values), and `created_at` (a date/time string).
@ -562,7 +562,7 @@ id | string | true |
Parameter | Type | Required | Description
--------- | ------- | --------- | -----------------------
datum | object | true | Data record including a `value` field (required) and optionally including: `lat`, `lon`, `ele` (latitude, longitude, and elevation values), and `created_at` (a date/time string).
<b>Request Body</b> | object | true | Data record (datum) including a `value` field (required) and optionally including: `lat`, `lon`, `ele` (latitude, longitude, and elevation values), and `created_at` (a date/time string).
@ -724,7 +724,7 @@ feed_key | string | true | a valid feed key
Parameter | Type | Required | Description
--------- | ------- | --------- | -----------------------
datum | object | true | Data record including a `value` field (required) and optionally including: `lat`, `lon`, `ele` (latitude, longitude, and elevation values), and `created_at` (a date/time string).
<b>Request Body</b> | object | true | Data record (datum) including a `value` field (required) and optionally including: `lat`, `lon`, `ele` (latitude, longitude, and elevation values), and `created_at` (a date/time string).

View file

@ -6,6 +6,8 @@ You will need to create one feed for each unique source of data you send to Adaf
You can create, read, update, or delete feeds. Every **CREATE**, **UPDATE**, or **DELETE** action on a feed record counts against your rate limit.
There are also endpoints for submitting multiple data points to a feed, or multiple feed values to a group, see **feeds/{feed_key}/batch** and **groups/{groupname}/data** endpoints.
## All Feeds
> HTTP Request

View file

@ -53,6 +53,7 @@ For example, if you are building a weather station, you would add feeds for `hum
You can create, read, update, or delete group records. Every **CREATE**, **UPDATE**, or **DELETE** action on a group record counts against your rate limit.
There is also an endpoint for submitting multiple feed values to a group, see the **groups/{groupname}/data** endpoint.
## Get All Groups