94 lines
3.4 KiB
HTML
94 lines
3.4 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html lang="en">
|
||
|
|
|
||
|
|
<head>
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="ie=edge">
|
||
|
|
<title>API Documentation</title>
|
||
|
|
|
||
|
|
<script src="//ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
|
||
|
|
<link rel="stylesheet" href="css/styles.css">
|
||
|
|
|
||
|
|
<link rel="apple-touch-icon" sizes="180x180" href="/res/apple-touch-icon.png">
|
||
|
|
<link rel="icon" type="image/png" sizes="32x32" href="/res/favicon-32x32.png">
|
||
|
|
<link rel="icon" type="image/png" sizes="16x16" href="/res/favicon-16x16.png">
|
||
|
|
<link rel="manifest" href="/res/site.webmanifest">
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body>
|
||
|
|
<div>
|
||
|
|
<h1>ARNweb API</h1>
|
||
|
|
</div>
|
||
|
|
<span class="apiReference get">
|
||
|
|
<span class="requestType get">GET</span>
|
||
|
|
<a href="/system"><code>/system</code></a><br>
|
||
|
|
<div>
|
||
|
|
<p>Returns json object containing general information about the server.</p>
|
||
|
|
</div>
|
||
|
|
</span>
|
||
|
|
|
||
|
|
<span class="apiReference get">
|
||
|
|
<span class="requestType get">GET</span>
|
||
|
|
<a href="/chat"><code>/chat</code></a><br>
|
||
|
|
<div>
|
||
|
|
<p>Returns json object containing general information about the chat server.</p>
|
||
|
|
</div>
|
||
|
|
</span>
|
||
|
|
|
||
|
|
<span class="apiReference get">
|
||
|
|
<span class="requestType get">GET</span>
|
||
|
|
<a href="/tanks"><code>/tanks</code></a><br>
|
||
|
|
<div>
|
||
|
|
<p>Returns json object containing status information about the TanksJS-Server instance.</p>
|
||
|
|
</div>
|
||
|
|
</span>
|
||
|
|
|
||
|
|
<span class="apiReference other">
|
||
|
|
<span class="requestType other">Socket</span>
|
||
|
|
<a href="/socket.io/"><code>/socket.io/</code></a><br>
|
||
|
|
<div>
|
||
|
|
<p>Socket.io instance that serves both ARNweb chat and a TanksJS server.</p>
|
||
|
|
<p>Use the following namespaces to access them accordingly:</p><br>
|
||
|
|
|
||
|
|
<b><code>/socket.io/tanks</code></b>
|
||
|
|
<p>TanksJS-server instance, see <a href="//gitea.arnweb.nl/arne/TanksJS-Server">TanksJS-Server</a> for more
|
||
|
|
information.</p><br>
|
||
|
|
|
||
|
|
<b><code>/socket.io/chat</code></b>
|
||
|
|
<p>Simple chat backend server for <a href="//arnweb.nl/account">ARNweb Chat</a>.<br>Use the following
|
||
|
|
communication steps to make your own client:</p>
|
||
|
|
<p>
|
||
|
|
<code><b>Server -> Client</b><br>user_identify { }</code>
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
<code><b>Server <- Client</b> <br>user_login { "username", "mailHash" }</code>
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
<code><b>Server <- Client</b> <br>message_send { "username", "mailHash", "message" }</code>
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
<code><b>Server -> Client</b><br>message_receive { "username", "mailHash", "message" }</code>
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
</span>
|
||
|
|
|
||
|
|
<span class="apiReference get">
|
||
|
|
<span class="requestType get">GET</span>
|
||
|
|
<code>/:game/:host</code><br>
|
||
|
|
<div>
|
||
|
|
<p>Returns json object containing information about the requested game server.</p>
|
||
|
|
<p>Powered by node-GameDig, more info on <a href="//www.npmjs.com/package/gamedig">npm</a>.</p>
|
||
|
|
</div>
|
||
|
|
</span>
|
||
|
|
|
||
|
|
<span class="apiReference other">
|
||
|
|
<span class="requestType other">cURL</span>
|
||
|
|
<code>/curl</code><br>
|
||
|
|
<div>
|
||
|
|
<p>Returns hello world to cURL requests.</p>
|
||
|
|
</div>
|
||
|
|
</span>
|
||
|
|
</body>
|
||
|
|
|
||
|
|
</html>
|