X bit API definition DOCUMENT

X-bit API definition DOCUMENT

Introduction

This doc is to define the RESTFul API of V1 x-bit

architecture

APIs

User Manager

1. Register

   POST 
   https://hostname/rest/settings/register
   {
     "username": xxx,
     "password": xxx,
     "phonenumber": xxx
   }
   

2. Login:

   GET 
   https://hostname/rest/settings/login
   {
      "username": xxx,
      "password": xxx
   }
   

3. List user Info:

   GET 
   https://hostname/rest/settings/user/<id>
   {
       "username": xxx,
       "userKeys":
       [
           "key1",
           "key2",
           ...
       ]
   }
   

4. Update User Info

   PUT 
   https://hostname/rest/settings/user/<id>
   {
       "password": xxx,
       "userKeys":
       [
           "key1",
           "key2",
           ...
       ]
   }