Changeset 2225 for trunk/grails-app/views/api/index.gsp

Timestamp:

Apr 25, 2012, 10:42:52 PM (10 years ago)

Author:

work@…

Message:

• changed application wide secret into a user specific api key which is automatically generated when a user is created. The key is available in the user's profile or through the user administration pages

File:

• trunk/grails-app/views/api/index.gsp (modified) (8 diffs)

trunk/grails-app/views/api/index.gsp

@@ -55 +55 @@
 <h2>prerequisites</h2>
     <li>a valid username / password with role ROLE_CLIENT (see <a href="#authenticate">authenticate</a>)</li>
-    <li>a shared secret (used to calculate the validation md5 hash)</li>
+    <li>an api key (used to calculate the validation md5 hash.
+        <sec:ifLoggedIn>
+            Get your api key <g:link controller="userRegistration" action="profile">here</g:link>
+        </sec:ifLoggedIn>
+        <sec:ifNotLoggedIn>
+            Login to get your api key
+        </sec:ifNotLoggedIn>
+    )</li>
     <li>a deviceID / clientID (look <a href="https://github.com/4np/UIDevice-with-UniqueIdentifier-for-iOS-5" target="_new">here</a> for iOS)</li>
 
@@ -66 +73 @@
     <li><a href="#getMeasurementDataForAssay">getMeasurementDataForAssay</a> - fetch all measurement data for a given assay</li>
 
+<h2>SDK packages</h2>
+    <li><a href="https://github.com/4np/gscf4php" target="_new">PHP</a> - Object Oriented SDK for interacting with GSCF</li>
+
 <a name="authenticate"></a>
 <h1>authenticate</h1>
@@ -89 +99 @@
 <p>
     Every subsequent request the client does, needs to contain the validation MD5 hash, which is a MD5 sum of the concatenation of the device token,
-    the request sequence and a shared secret (e.g. <i>md5sum( token + sequence + shared secret )</i> ).<br/>
+    the request sequence and the api key (e.g. <i>md5sum( token + sequence + api key )</i> ).<br/>
     <i>Note that in order to be able to successfully authenticate or use the API in general, the user should have the ROLE_CLIENT assigned!</i>
 
@@ -172 +182 @@
             <td>string</td>
             <td>-</td>
-            <td><a href="http://www.miraclesalad.com/webtools/md5.php" target="_new">md5sum</a>( token + sequence + shared secret )</td>
+            <td><a href="http://www.miraclesalad.com/webtools/md5.php" target="_new">md5sum</a>( token + sequence + api key )</td>
             <td>9ae87836d38d4b86be6aeff93f2b049a</td>
             <td>yes</td>
@@ -212 +222 @@
             <td>string</td>
             <td>-</td>
-            <td><a href="http://www.miraclesalad.com/webtools/md5.php" target="_new">md5sum</a>( token + sequence + shared secret )</td>
+            <td><a href="http://www.miraclesalad.com/webtools/md5.php" target="_new">md5sum</a>( token + sequence + api key )</td>
             <td>9ae87836d38d4b86be6aeff93f2b049a</td>
             <td>yes</td>
@@ -260 +270 @@
             <td>string</td>
             <td>-</td>
-            <td><a href="http://www.miraclesalad.com/webtools/md5.php" target="_new">md5sum</a>( token + sequence + shared secret )</td>
+            <td><a href="http://www.miraclesalad.com/webtools/md5.php" target="_new">md5sum</a>( token + sequence + api key )</td>
             <td>9ae87836d38d4b86be6aeff93f2b049a</td>
             <td>yes</td>
@@ -308 +318 @@
         <td>string</td>
         <td>-</td>
-        <td><a href="http://www.miraclesalad.com/webtools/md5.php" target="_new">md5sum</a>( token + sequence + shared secret )</td>
+        <td><a href="http://www.miraclesalad.com/webtools/md5.php" target="_new">md5sum</a>( token + sequence + api key )</td>
         <td>9ae87836d38d4b86be6aeff93f2b049a</td>
         <td>yes</td>
@@ -516 +526 @@
         <td>string</td>
         <td>-</td>
-        <td><a href="http://www.miraclesalad.com/webtools/md5.php" target="_new">md5sum</a>( token + sequence + shared secret )</td>
+        <td><a href="http://www.miraclesalad.com/webtools/md5.php" target="_new">md5sum</a>( token + sequence + api key )</td>
         <td>9ae87836d38d4b86be6aeff93f2b049a</td>
         <td>yes</td>