49 lines
2.0 KiB
HTML
49 lines
2.0 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">
|
||
|
|
</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>
|
||
|
|
<span>Returns json object containing general information about the server.</span>
|
||
|
|
</div>
|
||
|
|
</span>
|
||
|
|
<span class="apiReference get">
|
||
|
|
<span class="requestType get">GET</span>
|
||
|
|
<a href="/chat"><code>/chat</code></a><br>
|
||
|
|
<div>
|
||
|
|
<span>Returns json object containing general information about the chat server.</span>
|
||
|
|
</div>
|
||
|
|
</span>
|
||
|
|
<span class="apiReference socket">
|
||
|
|
<span class="requestType socket">Socket</span>
|
||
|
|
<a href="/chat/socket.io/"><code>/chat/socket.io/</code></a><br>
|
||
|
|
<div>
|
||
|
|
<span>Socket.io instance used by the chat on ARNweb.</span><br><br>
|
||
|
|
<span><bold>Server -> Client</bold><br><code>user_identify { }</code></span><br><br>
|
||
|
|
<span><bold>Server <- Client</bold><br><code>user_login { "username", "mailHash" }</code></span><br><br>
|
||
|
|
<span><bold>Client -> Server</bold><br><code>message_send { "username", "mailHash", "message" }</code></span>
|
||
|
|
</div>
|
||
|
|
</span>
|
||
|
|
<span class="apiReference get">
|
||
|
|
<span class="requestType get">GET</span>
|
||
|
|
<code>/:game/:host</code><br>
|
||
|
|
<div>
|
||
|
|
<span>Returns json object containing information about the requested game server.</span><br>
|
||
|
|
<span><a href="//www.npmjs.com/package/game-server-query#games-list">Supported games</a></span>
|
||
|
|
</div>
|
||
|
|
</span>
|
||
|
|
</body>
|
||
|
|
</html>
|