imported>Maze: aagrinder.xyz

2019-10-31T21:36:10Z

aagrinder.xyz

imported>Maze: Created page with "The AAGRINDER server exposes a simple REST api which is used for account operations. The code for this api can be found at https://gitlab.com/MRAAGH/aag..."

2019-10-28T19:21:36Z

Created page with "The AAGRINDER server exposes a simple REST api which is used for account operations. The code for this api can be found at https://gitlab.com/MRAAGH/aag..."

New page

The AAGRINDER server exposes a simple [[wikipedia:rest api|REST api]] which is used for account operations. The code for this api can be found at https://gitlab.com/MRAAGH/aagrinder/blob/master/server/api/User.js

This page describes all the REST api endpoints. Not to be confused with [[AAGRINDER socket.io api|socket.io api endpoints]].

The examples assume you have a local AAGRINDER server running on port 8080 (default port). See [[Setting up a server|how to set up a server]].

== Check name ==
Checks whether an account name is available for registration
=== URL ===
/api/users/checkname
=== Method ===
<pre>POST</pre>
=== URL Params ===
None
=== Data Params ===
<pre>
name=[string]
</pre>
=== Possible responses ===
* <pre>{ message: 'Registration is not possible on this server. You should try to log in directly.', success: false, insecure: true }</pre>
* <pre>{ message: 'Missing form data', success: false}</pre>
* <pre>{ message: 'Username invalid ^[A-Za-z]([A-Za-z0-9 ]{0,10}[A-Za-z0-9])?$', success: false }</pre>
* <pre>{ message: 'Server error', success: false }</pre>
* <pre>{ message: 'Username taken', success: false, color: existingUser[0].color }</pre>
* <pre>{ message: 'OK', success: true }</pre>
=== Sample call ===
<pre>
curl localhost:8080/api/users/checkname --data "name=original"
</pre>

== Check password ==
Checks whether a password for an account is correct
=== URL ===
/api/users/checkpass
=== Method ===
<pre>POST</pre>
=== URL Params ===
None
=== Data Params ===
<pre>
name=[string]
password=[string]
</pre>
=== Possible responses ===
* <pre>{ message: 'This server does not use passwords.', success: false, insecure: true }</pre>
* <pre>{ message: 'Missing form data', success: false}</pre>
* <pre>{ message: 'Username invalid ^[A-Za-z]([A-Za-z0-9 ]{0,10}[A-Za-z0-9])?$', success: false }</pre>
* <pre>{ message: 'Password invalid ^.+$', success: false }</pre>
* <pre>{ message: 'Server error', success: false }</pre>
* <pre>{ message: 'Wrong password', success: false }</pre>
* <pre>{ message: 'User does not exist', success: false }</pre>
* <pre>{ message: 'OK', success: true }</pre>
=== Sample call ===
<pre>
curl localhost:8080/api/users/checkpass --data "name=original" --data "password=hihi"
</pre>

== Change password ==
Changes an account password
=== URL ===
/api/users/changepass
=== Method ===
<pre>POST</pre>
=== URL Params ===
None
=== Data Params ===
<pre>
name=[string]
oldpassword=[string]
newpassword=[string]
</pre>
=== Possible responses ===
* <pre>{ message: 'This server does not use passwords.', success: false, insecure: true }</pre>
* <pre>{ message: 'Missing form data', success: false}</pre>
* <pre>{ message: 'Username invalid ^[A-Za-z]([A-Za-z0-9 ]{0,10}[A-Za-z0-9])?$', success: false }</pre>
* <pre>{ message: 'Password invalid ^.+$', success: false }</pre>
* <pre>{ message: 'Server error', success: false }</pre>
* <pre>{ message: 'Wrong password', success: false }</pre>
* <pre>{ message: 'User does not exist', success: false }</pre>
* <pre>{ message: 'Password changed.', success: true }</pre>
=== Sample call ===
<pre>
curl localhost:8080/api/users/changepass --data "name=original" --data "oldpassword=hihi" --data "newpassword=hehe"
</pre>

== Register an account ==
Create a new account on the AAGRINDER server
=== URL ===
/api/users/register
=== Method ===
<pre>POST</pre>
=== URL Params ===
None
=== Data Params ===
<pre>
name=[string]
password=[string]
color=[string]
</pre>
=== Possible responses ===
* <pre>{ message: 'Missing form data', success: false }</pre>
* <pre>{ message: 'Username invalid ^[A-Za-z]([A-Za-z0-9 ]{0,10}[A-Za-z0-9])?$', success: false }</pre>
* <pre>{ message: 'Password invalid ^.+$', success: false }</pre>
* <pre>{ message: 'Color invalid ^[0-9a-f]{6}$', success: false }</pre>
* <pre>{ message: 'Color too dark', success: false }</pre>
* <pre>{ message: 'Server error', success: false }</pre>
* <pre>{ message: 'Username taken', success: false }</pre>
* <pre>{ message: 'Server error', success: false }</pre>
* <pre>{ message: 'Server error', success: false }</pre>
* <pre>{ message: 'Server error', success: false }</pre>
* <pre>{ message: 'User created', success: true }</pre>
* <pre>{ message: 'User created. Hi there, soru O.O', success: true }</pre>
=== Sample call ===
<pre>
curl localhost:8080/api/users/register --data "name=original" --data "password=hihi" --data "color=fdbcb4"
</pre>

@@ Line 2: / Line 2: @@
 This page describes all the REST api endpoints. Not to be confused with [[AAGRINDER socket.io api|socket.io api endpoints]].
 == Check name ==
@@ Line 26: / Line 24: @@
 === Sample call ===
 <pre>
-curl localhost:8080/api/users/checkname --data "name=original"
+curl https://aagrinder.xyz/api/users/checkname --data "name=original"
 </pre>
@@ Line 53: / Line 51: @@
 === Sample call ===
 <pre>
-curl localhost:8080/api/users/checkpass --data "name=original" --data "password=hihi"
+curl https://aagrinder.xyz/api/users/checkpass --data "name=original" --data "password=hihi"
 </pre>
@@ Line 81: / Line 79: @@
 === Sample call ===
 <pre>
-curl localhost:8080/api/users/changepass --data "name=original" --data "oldpassword=hihi" --data "newpassword=hehe"
+curl https://aagrinder.xyz/api/users/changepass --data "name=original" --data "oldpassword=hihi" --data "newpassword=hehe"
 </pre>
@@ Line 113: / Line 111: @@
 === Sample call ===
 <pre>
-curl localhost:8080/api/users/register --data "name=original" --data "password=hihi" --data "color=fdbcb4"
+curl https://aagrinder.xyz/api/users/register --data "name=original" --data "password=hihi" --data "color=fdbcb4"
 </pre>

AAGRINDER REST api - Revision history

imported>Maze: aagrinder.xyz

imported>Maze: Created page with "The AAGRINDER server exposes a simple REST api which is used for account operations. The code for this api can be found at https://gitlab.com/MRAAGH/aag..."