mirror of
https://github.com/Expand-sys/CCash
synced 2025-12-17 00:22:14 +11:00
85 lines
5 KiB
HTML
85 lines
5 KiB
HTML
<body>
|
|
<h1>ALL FUNCTIONS (that have args) ARE EXPECTING JSON AS DATA TYPE</h1>
|
|
<h2>/BankF/<span style="color: #993300;">admin</span>/close (POST)</h2>
|
|
<p><span style="background-color: #808080;"> attempt </span> - admin password</p>
|
|
<blockquote>
|
|
<p>Closes and Saves the server.</p>
|
|
</blockquote>
|
|
<h2>/BankF/user (POST)</h2>
|
|
<p><span style="background-color: #808080;"> name </span> - name of the user being added (must be less then 50 characters)</p>
|
|
<p><span style="background-color: #808080;"> init_pass </span> - initial password for the user being added</p>
|
|
<blockquote>
|
|
<p>Adds a user to the bank</p>
|
|
</blockquote>
|
|
<h2>/BankF/<span style="color: #993300;">admin</span>/user (POST)</h2>
|
|
<p><span style="background-color: #808080;"> name </span> - name of the user being added</p>
|
|
<p><span style="background-color: #808080;"> attempt </span> - admin password required to add user with balance</p>
|
|
<p><span style="background-color: #808080;"> init_bal </span> - initial balance for user being added</p>
|
|
<p><span style="background-color: #808080;"> init_pass </span> - initial password for user being added</p>
|
|
<blockquote>
|
|
<p>Adds a user with initial balance</p>
|
|
</blockquote>
|
|
<h2>/BankF/sendfunds (POST)</h2>
|
|
<p><span style="background-color: #808080;"> a_name </span> - sender's name</p>
|
|
<p><span style="background-color: #808080;"> b_name </span> - reciever's name</p>
|
|
<p><span style="background-color: #808080;"> amount </span> - amount being sent</p>
|
|
<p><span style="background-color: #808080;"> attempt </span> - password of sender</p>
|
|
<blockquote>
|
|
<p>Sends money from one user to another</p>
|
|
</blockquote>
|
|
<h2>/BankF/changepass (PATCH)</h2>
|
|
<p><span style="background-color: #808080;"> name </span> - name of user's password being changes</p>
|
|
<p><span style="background-color: #808080;"> attempt </span> - password of user being changed</p>
|
|
<p><span style="background-color: #808080;"> new_pass </span> - new password to replace the current user's password</p>
|
|
<blockquote>
|
|
<p>Changes password of a user, returns -1 if user doesnt exist</p>
|
|
</blockquote>
|
|
<h2>/BankF/<span style="color: #993300;">admin</span>/{<span style="color: #339966;">name</span>}/bal (PATCH)</h2>
|
|
<p><span style="background-color: #808080;"> name </span> - the name of the user being set</p>
|
|
<p><span style="background-color: #808080;"> attempt </span> - the admin password required</p>
|
|
<p><span style="background-color: #808080;"> amount </span> - the new balance of the user</p>
|
|
<blockquote>
|
|
<p>Sets the balance of a user</p>
|
|
</blockquote>
|
|
<h2>/BankF/help (GET)</h2>
|
|
<blockquote>
|
|
<p>the page you're looking at right now!</p>
|
|
</blockquote>
|
|
<h2>/BankF/vpass (POST)</h2>
|
|
<p><span style="background-color: #808080;"> name </span> - name of user being verified</p>
|
|
<p><span style="background-color: #808080;"> attempt </span> - password being verified</p>
|
|
<blockquote>
|
|
<p>returns 0 or 1 based on if [attempt] is equal to the password of the user [name], or -1 if user does not exist. The intended usage for this function is for connected services</p>
|
|
</blockquote>
|
|
<h2>/BankF/contains/{<span style="color: #339966;">name</span>} (GET)</h2>
|
|
<blockquote>
|
|
<p>returns a 0 or 1 based on if the bank contains the user</p>
|
|
</blockquote>
|
|
<h2>/BankF/{<span style="color: #339966;">name</span>}/bal (GET)</h2>
|
|
<blockquote>
|
|
<p>returns the balance of a given user's name, if -1 that means the user does not exist</p>
|
|
</blockquote>
|
|
<h2>/BankF/<span style="color: #993300;">admin</span>/vpass (POST)</h2>
|
|
<p><span style="background-color: #808080;"> attempt </span> - admin password</p>
|
|
<blockquote>
|
|
<p>Verifies if password entered is admin password</p>
|
|
</blockquote>
|
|
<h2>/BankF/{<span style="color: #339966;">name</span>}/log (POST)</h2>
|
|
<p><span style="background-color: #808080;"> attempt </span> - user password</p>
|
|
<blockquote>
|
|
<p>returns a list of last 100 transactions, -1 if user not found, 0 if invalid password</p>
|
|
</blockquote>
|
|
<h2>/BankF/user (DELETE)</h2>
|
|
<p><span style="background-color: #808080;"> name </span> - name of user being deleted</p>
|
|
<p><span style="background-color: #808080;"> attempt </span> - password of user being deleted</p>
|
|
<blockquote>
|
|
<p>Deletes a user with the password of the user as verification</p>
|
|
</blockquote>
|
|
<h2>/BankF/<span style="color: #993300;">admin</span>/user (DELETE)</h2>
|
|
<p><span style="background-color: #808080;"> name </span> - name of user being deleted</p>
|
|
<p><span style="background-color: #808080;"> attempt </span> - admin password</p>
|
|
<blockquote>
|
|
<p>Deletes a user with admin password as verification</p>
|
|
</blockquote>
|
|
</body>
|
|
|