Больше комментариев

user_api/call2user_api.py

@@ -54,16 +54,37 @@ async def call(api_url, data, pre=True, fix=True):
 # UserAPI
 #------------------------------------------------------------
 # Получение информации о токене
+# IN : username (str), user_token (str)
+# OUT: {'issue_date': str, 'logs': str} / 'Invalid username or token' (401) / 'Token not exist' (404) / General error (500)
 async def get_user_token_info(username, user_token):
 	data = {'username': username, 'user_token': user_token}
 	return await call('api/get_user_token_info/', data)
 
 # Получение пользователя (ник, айди ТГ, ДС и т.п.)
+# IN : username (str), user_token (str)
+# OUT: {
+#   "creator_id_type": str,
+#   "username": str,
+#   "mine_uuid": str,
+#   "tg_id": int,
+#   "balance": float,
+#   "tokens": "{}",
+#   "password": "HIDDEN",
+#   "creator_id": str,
+#   "mine_name": str,
+#   "ds_id": int,
+#   "frozen": "no"/"temporarily"/"forever",
+#   "last_activity": null,
+# } / 'Invalid username or token' (401) / 'User not found' (404) / General error (500)
 async def user_in_db(username, user_token):
 	data = {'username': username, 'user_token': user_token}
 	return await call('api/user_in_db/', data)
 
 # Перевод монет
+# IN : username (str), user_token (str), dst_username (str), amount (float)
+# OUT: 'OK' / 'Invalid username or token' (401) / 'No money' (400) / 'Too low' (400)
+# / 'User not found' (404) / 'Frozen temporarily' (401) / 'Frozen forever' (401)
+# / General error (500)
 async def transfer_coins(username, user_token,
 						 dst_username, amount):
 	data = {'username': username, 'user_token': user_token,
@@ -71,12 +92,26 @@ async def transfer_coins(username, user_token,
 	return await call('api/transfer_coins/', data)
 
 # Получение глобальной статистики
+# IN : username (str), user_token (str)
+# OUT: {
+#   "amount": float,
+#   "frozen_amount": int,
+#   "users": int,
+#   "frozen_users": int,
+#   "average": float,
+#   "median": float,
+#   "min": float,
+#   "max": float
+# } / 'Invalid username or token' (401) / General error (500)
 async def get_stats(username, user_token):
 	data = {'username': username, 'user_token': user_token}
 	return await call('api/get_stats/', data)
 
 # Создание счёта на оплату, чтобы проверить оплачен ли он
 # Использование в боте: /pay <ник> <сумма> <invoice_id>
+# IN : username (str), user_token (str), amount (float)
+# OUT: invoice_id (str) / 'Invalid username or token' (401) / 'Destination user not found' (401)
+# / General error (500)
 async def create_invoice(username, user_token, amount=None):
 	data = {'username': username, 'user_token': user_token}
 	if amount:
@@ -84,12 +119,20 @@ async def create_invoice(username, user_token, amount=None):
 	return await call('api/create_invoice/', data)
 
 # Удаление счёта на оплату по invoice_id
+# IN : username (str), user_token (str), invoice_id (str)
+# OUT: 'OK' / 'Invalid username or token' (401) / 'Invoice id not found' (404) / General error (500)
 async def delete_invoice(username, user_token, id):
 	data = {'username': username, 'user_token': user_token, 'id': id}
 	return await call('api/delete_invoice/', data)
 
-# Получение информации о счёте на оплату:
-# конечный получатель, сумма, статус (оплачен/нет: True/False)
+# Получение информации о счёте на оплату
+# IN : username (str), user_token (str), invoice_id (str)
+# OUT: {
+#   "id": str,
+#   "dst_username": str,
+#   "amount": null / float,
+#   "status": false/true
+# } / 'Invalid username or token' (401) / 'Invoice id not found' (404) / General error (500)
 async def get_invoice(username, user_token, id):
 	data = {'username': username, 'user_token': user_token, 'id': id}
 	return await call('api/get_invoice/', data)
@@ -100,10 +143,17 @@ async def get_invoice(username, user_token, id):
 # SystemAPI usage only
 #------------------------------------------------------------
 # Здесь вы ничего не используете, пропускайте
+
+# For SystemAPI ONLY
+# IN : token (str), user_token (str)
+# OUT: 'OK' / 'Invalid token' (401) / 'Token already exist' (409) / General error (500)
 async def register_user_token(token, user_token):
 	data = {'token': token, 'user_token': user_token}
 	return await call('api/register_user_token/', data)
 
+# For SystemAPI ONLY
+# IN : token (str), user_token (str)
+# OUT: 'OK' / 'Invalid token' (401) / 'Token not exist' (404) / General error (500)
 async def unregister_user_token(token, user_token):
 	data = {'token': token, 'user_token': user_token}
 	return await call('api/unregister_user_token/', data)