From c9b52c3acc2398ce677efa56cd5f689e9e564429 Mon Sep 17 00:00:00 2001 From: Justin Cooper Date: Tue, 30 Jul 2024 13:48:22 -0500 Subject: [PATCH] Note about query parameters and api keys --- source/includes/_authentication.md.erb | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/includes/_authentication.md.erb b/source/includes/_authentication.md.erb index 103e37d..26ba849 100644 --- a/source/includes/_authentication.md.erb +++ b/source/includes/_authentication.md.erb @@ -34,3 +34,5 @@ api = Adafruit::IO::Client.new key: api_key, username: username When making HTTP requests to Adafruit IO, you can include the API key as a query parameter named `x-aio-key` or as a request header named `X-AIO-Key`. In both cases, "X-AIO-Key" is case insensitive. **NOTE**: if you regenerate your AIO key, your old key will be immediately invalidated, so you'll have to replace it in any scripts or sketches where it is in use. + +**NOTE**: it is a best practice to avoid including your API key in the URL as a query parameter. Some situations may require this, but try to avoid it if you can.