@@ -360,6 +360,18 @@ CREATE TABLE `video_timestamps` (
UNIQUE KEY `gid_user_id` (`gid`, `user_id`)
);
+CREATE TABLE `api_key` (
+ `id` int(11) NOT NULL auto_increment,
+ `user_id` mediumint(9) NOT NULL,
+ `api_key` char(24) NOT NULL,
+ `commercial` tinyint(1) NOT NULL,
+ `created` datetime NOT NULL,
+ `disabled` datetime default NULL,
+ `reason` text NOT NULL,
+ PRIMARY KEY (`id`),
+ KEY `api_key` (`api_key`)
+);
+
CREATE TABLE `api_stats` (
`id` int(11) NOT NULL auto_increment,
`api_key` char(24) NOT NULL,
db/schema.sql
@@ -14,34 +14,73 @@ api_key_current_message();
echo '<p>TheyWorkForYou API calls require a key, so that we can monitor usage
of the service, and provide usage stats to you.';
if ($THEUSER->loggedin()) {
+ if (get_http_var('create_key')) {
+ create_key(get_http_var('commercial'), get_http_var('reason'));
+ }
$db = new ParlDB;
- $q = $db->query('SELECT api_key FROM users WHERE user_id=' . $THEUSER->user_id());
- $key = $q->field(0, 'api_key');
- if (!$key) {
- # Haven't yet got a key, generate one
- $key = auth_ab64_encode(random_bytes(16));
- $db->query('UPDATE users SET api_key="' . $key . '" where user_id=' . $THEUSER->user_id());
+ $q = $db->query('SELECT api_key, commercial, created, reason FROM api_key WHERE user_id=' . $THEUSER->user_id());
+ $keys = array();
+ for ($i=0; $i<$q->rows(); $i++) {
+ $keys[] = array($q->field($i, 'api_key'), $q->field($i, 'commercial'), $q->field($i, 'created'), $q->field($i, 'reason'));
+ }
+ if ($keys) {
+ echo '<h3>Your keys</h3> <ul>';
+ }
+ foreach ($keys as $keyarr) {
+ list($key, $commercial, $created, $reason) = $keyarr;
+ echo '<li><span style="font-size:200%">' . $key . '</span><br><span style="color: #666666;">';
+ echo $commercial ? 'Commercial' : 'Non-commercial';
+ echo ' key, created ', $created; # , ' ', $reason;
+ echo '</span><br><em>Usage statistics</em>: ';
+ $q = $db->query('SELECT count(*) as count FROM api_stats WHERE api_key="' . $key . '" AND query_time > NOW() - interval 1 day');
+ $c = $q->field(0, 'count');
+ echo "last 24 hours: $c, ";
+ $q = $db->query('SELECT count(*) as count FROM api_stats WHERE api_key="' . $key . '" AND query_time > NOW() - interval 1 week');
+ $c = $q->field(0, 'count');
+ echo "last week: $c, ";
+ $q = $db->query('SELECT count(*) as count FROM api_stats WHERE api_key="' . $key . '" AND query_time > NOW() - interval 1 month');
+ $c = $q->field(0, 'count');
+ echo "last month: $c";
+ echo '</p>';
}
- echo '<p style="font-size:200%">Your key is: ', $key, '</p>';
- echo '<h3>Usage stats</h3> <ul style="font-size:125%">';
- $q = $db->query('SELECT count(*) as count FROM api_stats WHERE api_key="' . $key . '" AND query_time > NOW() - interval 1 day');
- $c = $q->field(0, 'count');
- echo "<li>Last 24 hours: $c";
- $q = $db->query('SELECT count(*) as count FROM api_stats WHERE api_key="' . $key . '" AND query_time > NOW() - interval 1 week');
- $c = $q->field(0, 'count');
- echo "<li>Last week: $c";
- $q = $db->query('SELECT count(*) as count FROM api_stats WHERE api_key="' . $key . '" AND query_time > NOW() - interval 1 month');
- $c = $q->field(0, 'count');
- echo "<li>Last month: $c";
- echo '</ul>';
+ if ($keys) {
+ echo '</ul>';
+ }
+ api_key_form();
} else {
- echo ' This key is tied to your TheyWorkForYou account,
+ echo ' The key is tied to your TheyWorkForYou account,
so if you don\'t yet have one, please <a href="/user/?pg=join">sign up</a>, then
-return here to find your key.</p>';
- echo '<p style="font-size:200%"><strong><a href="/user/login/?ret=/api/key">Log in</a></strong> (or <a href="/user/?pg=join">sign up</a>) to view your API key.</p>';
+return here to get a key.</p>';
+ echo '<p style="font-size:200%"><strong><a href="/user/login/?ret=/api/key">Log in</a></strong> (or <a href="/user/?pg=join">sign up</a>) to get an API key.</p>';
}
$sidebar = api_sidebar();
$PAGE->stripe_end(array($sidebar));
$PAGE->page_end();
+# ---
+
+function create_key($commercial, $reason) {
+ global $THEUSER;
+ $key = auth_ab64_encode(random_bytes(16));
+ $db = new ParlDB;
+ $db->query('INSERT INTO api_key (user_id, api_key, commercial, created, reason) VALUES
+ (' . $THEUSER->user_id() . ', "' . $key . '", ' . $commercial . ', NOW(), "' . $reason . '")');
+}
+
+function api_key_form() {
+?>
+<br>
+<h3>Apply for a new key</h3>
+<form action="/api/key" method="post">
+<p>Is your application for:
+<input id="non_comm" type="radio" name="commercial" value="0"> <label for="non_comm">Non-commercial use</label>
+<input id="comm" type="radio" name="commercial" value="1"> <label for="comm">Commercial use</label>
+<p><label for="reason">Please describe what you're going to use the key for:</label>
+<br>
+<textarea id="reasons" name="reason" rows=7 cols=40></textarea>
+<p><input type="submit" value="Get key">
+<input type="hidden" name="create_key" value="1">
+</form>
+<?
+}
www/docs/api/key.php
264dc96ec4dbc5e4d6c917c38949ef04dc831915
matthew
matthew
http://github.com/mlandauer/twfy/commit/6c7aae9d225e638f81bd7c888333b9ef7762b028
6c7aae9d225e638f81bd7c888333b9ef7762b028
2008-08-07T23:26:08-07:00
2008-07-21T03:18:51-07:00
Put keys in separate table so can have multiple keys, ask for reason of key use.
023c200d246ad2daaf79daaa70105ed29c5b6c64
Matthew Landauer
matthew@openaustralia.org