aboutsummaryrefslogtreecommitdiffstats
path: root/site/public/index.html
diff options
context:
space:
mode:
authorYigit Sever2021-04-16 16:40:52 +0300
committerYigit Sever2021-04-16 16:40:52 +0300
commit8febc2b12a29c00035ad7a4d79fee9417a00b827 (patch)
treed3939280f498676027e5a840bcdf6c2870150d0b /site/public/index.html
parentc6b90ff7abe2122fbac8f9e1066bd8cecbf135cd (diff)
downloadgradecoin-8febc2b12a29c00035ad7a4d79fee9417a00b827.tar.gz
gradecoin-8febc2b12a29c00035ad7a4d79fee9417a00b827.tar.bz2
gradecoin-8febc2b12a29c00035ad7a4d79fee9417a00b827.zip
Fix the damn public/
Diffstat (limited to 'site/public/index.html')
-rw-r--r--site/public/index.html8
1 files changed, 6 insertions, 2 deletions
diff --git a/site/public/index.html b/site/public/index.html
index 09bfdb1..8dcb1d0 100644
--- a/site/public/index.html
+++ b/site/public/index.html
@@ -219,26 +219,29 @@ The server is programmed in <a href="https://www.service-architecture.com/articl
219<li>Downloads <code>Gradecoin</code>'s Public Key from <a href="https://odtuclass.metu.edu.tr/my/">Moodle</a></li> 219<li>Downloads <code>Gradecoin</code>'s Public Key from <a href="https://odtuclass.metu.edu.tr/my/">Moodle</a></li>
220<li>Encrypts their <a href="https://www.json.org/json-en.html">JSON</a> wrapped <code>Public Key</code>, <code>Student ID</code> and one time <code>passwd</code> using Gradecoin's Public Key</li> 220<li>Encrypts their <a href="https://www.json.org/json-en.html">JSON</a> wrapped <code>Public Key</code>, <code>Student ID</code> and one time <code>passwd</code> using Gradecoin's Public Key</li>
221<li>Their public key is now in our database and can be used to sign their JWT's during requests</li> 221<li>Their public key is now in our database and can be used to sign their JWT's during requests</li>
222<li>For more information, check our <a href="https://gradecoin.xyz/register-docs/">register</a> page.</li>
222</ul> 223</ul>
223<h2 id="transaction">/transaction</h2> 224<h2 id="transaction">/transaction</h2>
224<ul> 225<ul>
225<li>You can offer a <a href="/transaction">Transaction</a> - POST request 226<li>You can offer a <a href="https://gradecoin.xyz/transaction-docs/">Transaction</a> - POST request
226<ul> 227<ul>
227<li>The request should have <code>Authorization</code></li> 228<li>The request should have <code>Authorization</code></li>
228<li>The request header should be signed by the Public Key of the <code>by</code> field in the transaction</li> 229<li>The request header should be signed by the Public Key of the <code>by</code> field in the transaction</li>
229</ul> 230</ul>
230</li> 231</li>
231<li>fetch the list of <code>Transaction</code>s - GET request</li> 232<li>fetch the list of <code>Transaction</code>s - GET request</li>
233<li>For more information, check our <a href="https://gradecoin.xyz/transaction-docs/">transaction</a> page.</li>
232</ul> 234</ul>
233<h2 id="block">/block</h2> 235<h2 id="block">/block</h2>
234<ul> 236<ul>
235<li>offer a [<code>schema::Block</code>] - POST request 237<li>offer a <a href="https://gradecoin.xyz/block-docs/">Block</a> - POST request
236<ul> 238<ul>
237<li>The request should have <code>Authorization</code></li> 239<li>The request should have <code>Authorization</code></li>
238<li>The [<code>schema::Block::transaction_list</code>] of the block should be a subset of [<code>schema::Db::pending_transactions</code>]</li> 240<li>The [<code>schema::Block::transaction_list</code>] of the block should be a subset of [<code>schema::Db::pending_transactions</code>]</li>
239</ul> 241</ul>
240</li> 242</li>
241<li>fetch the last accepted [<code>schema::Block</code>] - GET request</li> 243<li>fetch the last accepted [<code>schema::Block</code>] - GET request</li>
244<li>For more information, check our <a href="https://gradecoin.xyz/block-docs/">block</a> page.</li>
242</ul> 245</ul>
243<p><code>Authorization</code>: The request header should have Bearer JWT.Token signed with Student Public Key</p> 246<p><code>Authorization</code>: The request header should have Bearer JWT.Token signed with Student Public Key</p>
244<h1 id="questions">Questions</h1> 247<h1 id="questions">Questions</h1>
@@ -248,6 +251,7 @@ The server is programmed in <a href="https://www.service-architecture.com/articl
248<li>Don't know where to start? Gradecoin uses RESTful API; simple <code>curl</code> commands or even your browser will work! <a href="https://curl.trillworks.com/">This website can help as well</a>.</li> 251<li>Don't know where to start? Gradecoin uses RESTful API; simple <code>curl</code> commands or even your browser will work! <a href="https://curl.trillworks.com/">This website can help as well</a>.</li>
249<li><a href="https://jwt.io">JWT Debugger</a> and the corresponding <a href="https://tools.ietf.org/html/rfc7519">RFC</a></li> 252<li><a href="https://jwt.io">JWT Debugger</a> and the corresponding <a href="https://tools.ietf.org/html/rfc7519">RFC</a></li>
250<li>Remember that you are absolutely encouraged to grab off-the-shelf implementations for every cryptography primitive you will use. You can start by finding a code snippet to generate a RSA keypair?</li> 253<li>Remember that you are absolutely encouraged to grab off-the-shelf implementations for every cryptography primitive you will use. You can start by finding a code snippet to generate a RSA keypair?</li>
254<li>Check out <a href="https://gradecoin.xyz/misc-docs/">misc</a> for everything else you might be curious about.</li>
251</ul> 255</ul>
252<h2 id="i-found-a-bug">I found a bug!</h2> 256<h2 id="i-found-a-bug">I found a bug!</h2>
253<p>Thank you! Please <a href="mailto:yigit@ceng.metu.edu.tr">let me know</a> so we can solve it.</p> 257<p>Thank you! Please <a href="mailto:yigit@ceng.metu.edu.tr">let me know</a> so we can solve it.</p>