c_meyer/thingspeak
1
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

update docs for API keys

Browse Source
This commit is contained in:
Lee Lawlor 2014-06-18 12:31:58 -04:00
parent 8c37a03112
commit 7e17e85edb
6 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
app/controllers/charts_controller.rb
View File

@ -38,7 +38,7 @@ class ChartsController < ApplicationController
def show
# allow these parameters when creating feed querystring
feed_params = ['key','days','start','end','round','timescale','average','median','sum','results','location','status']
feed_params = ['key', 'api_key', 'apikey', 'days','start','end','round','timescale','average','median','sum','results','location','status']
# set chart size
width = params[:width].present? ? params[:width] : Chart.default_width

6
app/views/docs/channels/_feed.html.erb
View File

@ -10,7 +10,7 @@ replacing <span class="customcode">CHANNEL_ID</span> with the ID of your Channel
<br><br>
Valid parameters:
<ul>
<li><b>key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
<li><b>api_key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
<li><b>results</b> (integer) Number of entries to retrieve, 8000 max, default of 100 (optional)</li>
<li><b>days</b> (integer) Number of 24-hour periods before now to include in feed (optional)</li>
<li><b>start</b> (datetime) Start date in format YYYY-MM-DD%20HH:NN:SS (optional)</li>
@ -176,7 +176,7 @@ replacing <span class="customcode">CHANNEL_ID</span> with the ID of your Channel
<br><br>
Valid parameters:
<ul>
<li><b>key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
<li><b>api_key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
<li><b>timezone</b> (string) <a href="/docs#timezones">Timezone identifier</a> for this request (optional)</li>
<li><b>offset</b> (integer) Timezone offset that results should be displayed in. Please use the <a href="/docs#timezones">timezone</a> parameter for greater accuracy. (optional)</li>
<li><b>status</b> (true/false) Include status updates in feed by setting "status=true" (optional)</li>
@ -249,7 +249,7 @@ replacing <span class="customcode">CHANNEL_ID</span> with the ID of your Channel
<br><br>
Valid parameters:
<ul>
<li><b>key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
<li><b>api_key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
<li><b>timezone</b> (string) <a href="/docs#timezones">Timezone identifier</a> for this request (optional)</li>
<li><b>offset</b> (integer) Timezone offset that results should be displayed in. Please use the <a href="/docs#timezones">timezone</a> parameter for greater accuracy. (optional)</li>
<li><b>status</b> (true/false) Include status updates in feed by setting "status=true" (optional)</li>

4
app/views/docs/channels/_field.html.erb
View File

@ -10,7 +10,7 @@ replacing <span class="customcode">CHANNEL_ID</span> with the ID of your Channel
<br><br>
Valid parameters:
<ul>
<li><b>key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
<li><b>api_key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
<li><b>results</b> (integer) Number of entries to retrieve, 8000 max, default of 100 (optional)</li>
<li><b>days</b> (integer) Number of 24-hour periods before now to include in feed (optional)</li>
<li><b>start</b> (datetime) Start date in format YYYY-MM-DD%20HH:NN:SS (optional)</li>
@ -160,7 +160,7 @@ replacing <span class="customcode">CHANNEL_ID</span> with the ID of your Channel
<br><br>
Valid parameters:
<ul class="format-block">
<li><b>key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
<li><b>api_key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
<li><b>timezone</b> (string) <a href="/docs#timezones">Timezone identifier</a> for this request (optional)</li>
<li><b>offset</b> (integer) Timezone offset that results should be displayed in. Please use the <a href="/docs#timezones">timezone</a> parameter for greater accuracy. (optional)</li>
<li><b>status</b> (true/false) Include status updates in feed by setting "status=true" (optional)</li>

2
app/views/docs/channels/_status.html.erb
View File

@ -10,7 +10,7 @@ replacing <span class="customcode">CHANNEL_ID</span> with the ID of your Channel
<br><br>
Valid parameters:
<ul>
<li><b>key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
<li><b>api_key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
<li><b>timezone</b> (string) <a href="/docs#timezones">Timezone identifier</a> for this request (optional)</li>
<li><b>offset</b> (integer) Timezone offset that results should be displayed in. Please use the <a href="/docs#timezones">timezone</a> parameter for greater accuracy. (optional)</li>
<li><b>callback</b> (string) Function name to be used for JSONP cross-domain requests (optional)</li>

2
app/views/docs/charts.html.erb
View File

@ -40,7 +40,7 @@
<br>
Valid feed parameters:
<ul>
<li><b>key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
<li><b>api_key</b> (string) Read API Key for this specific Channel (optional--no key required for public channels)</li>
<li><b>results</b> (integer) Number of entries to retrieve, 8000 max, default of 100 (optional)</li>
<li><b>days</b> (integer) Number of 24-hour periods before now to include in feed (optional)</li>
<li><b>start</b> (datetime) Start date in format YYYY-MM-DD%20HH:NN:SS (optional)</li>

4
app/views/docs/index.html.erb
View File

@ -30,7 +30,9 @@
<br><br>
<h4 id="headers">HTTP Headers</h4>
If you would like to reduce the number of HTTP headers sent by our application, please add the parameter "headers=false" to any HTTP request.
If you would like to reduce the number of HTTP headers sent by our application, please add the parameter <code>headers=false</code> to any HTTP request.
<br><br>
API keys can optionally be sent via HTTP headers by setting the header name to <code><%= HTTP_HEADER_API_KEY_NAME %></code> and the header value to the API key.
<br><br><br><br>
<h4 id="timezones">Time Zones Reference</h4>