tj

igirl-channel/app/front/entry/public/apidoc/README.md

@@ -16,5 +16,8 @@
 ## 2. 商标检索相关接口
 　　1 [商标检索中心](doc/api/opTrademark/tmSearch.md)
 
-## 2. 支付相关接口
+## 3. 支付相关接口
 　　1 [支付中心](doc/api/paymentDesc/payment.md)
+
+## 3. 用户中心相关接口
+　　1 [用户中心](doc/api/user/user.md)
\ No newline at end of file

igirl-channel/app/front/entry/public/apidoc/paymentDesc/payment.md

@@ -10,7 +10,7 @@
 #### 渠道执行的类型 actionType：paypc
 ``` javascript
     {
-        "app_id": "1",   //渠道ｉｄ
+        "uapp_id": "1",   //平台渠道ID
         "order_num": "1", //支付单号
         "total_fee": "1",　　　//支付金额　　分
         "body_desc": "1",　　　　//产品名称

igirl-channel/app/front/entry/public/apidoc/user/user.md

-<a name="menu">目录</a>
+<a name="menu" href="/doc">返回主目录</a>
 1. [短信验证码](#smsCode)
-1. [登录](#login)
-1. [当前用户信息查询](#loginUser)
-1. [获取菜单](#getMenu)
+1. [密码登录](#pwdLogin)
+1. [验证码登录](#userPinByLgoinVcode)
+1. [用户注册](#userPinByRegister)
 
 
 ## **<a name="smsCode"> 短信验证码</a>**
 [返回到目录](#menu)
 ##### URL
-[/web/auth/userCtl/smsCode]
+[/web/auth/accessAuth/springBoard]
 #### 参数格式  `JSON`
 #### HTTP请求方式 `POST`
-|   参数   | 必选      |    类型   |      说明|
-| -------- | -------- | ------------|---------|
-| **mobile**  |  是     |  String     | 手机号码|
+#### 渠道执行的类型 actionType：getVerifyCode
+
+``` javascript
+    {
+        "mobile":"15010929366" // Y 手机号
+    }
+```
 
 #### 返回结果
 ```javascript
-
-{
-    "status": 0,
-    "msg": "success",
-}
-
+    {
+        "status": 0, // 0为成功，否则失败
+        "msg": "success",
+        "data": null,
+        "requestId": "4f3ea2afee3542f88d6b938394af84d8"
+    }
 ```
 
 
-## **<a name="login"> 登录</a>**
+## **<a name="pwdLogin"> 密码登录</a>**
 [返回到目录](#menu)
 ##### URL
-[/web/auth/userCtl/login]
+[/web/auth/accessAuth/springBoard]
 #### 参数格式  `JSON`
 #### HTTP请求方式 `POST`
-|   参数   | 必选      |    类型   |      说明|
-| -------- | -------- | ------------|---------|
-| **loginName**  |  是     |  String     | 登录名|
-| **password**  |  是    |  String     | 密码 |
-| **captchaKey**  |  是    |  String     | 图片验证码key |
-| **captchaCode**  |  是    |  String     | 图片验证码填入值 |
+#### 渠道执行的类型 actionType：userPinByLgoin
 
+``` javascript
+    {
+        "mobile":"15010929366", // Y 手机号
+        "password":"123456"    // Y 密码
+    }
+```
 
 #### 返回结果
-```javascript
-{
-    "status": 0,
-    "msg": "success",
-    "data": {
-        "xggadminsid": "3cb49932-fa02-44f0-90db-9f06fe02e5c7"   // 登录key
+``` javascript
+    {
+        "status": 0,// 0为成功，2010为账户或密码错误，2060为重复登录，否则失败
+        "msg": "success",
+        "data": {
+            "userpin": "230ecdf3333944ff834f56fba10a02aa" //用户登录后的凭证，增、删、改、查、涉及用户的需要传递此值在请求头中
+        },
+        "requestId": "1b12b0e9c190436da000386ddf693c8f"
     }
-}
-
 ```
 
 
 
-## **<a name="currentUser"> 当前用户信息查询</a>**
+## **<a name="userPinByLgoinVcode"> 验证码登录</a>**
 [返回到目录](#menu)
 ##### URL
-[/web/auth/userCtl/currentUser]
+[/web/auth/accessAuth/springBoard]
 #### 参数格式  `JSON`
 #### HTTP请求方式 `POST`
+#### 渠道执行的类型 actionType：userPinByLgoinVcode
+``` javascript
+    {
+        "mobile":"15010929366", // Y 手机号
+        "vcode":"593555"   //  Y 验证码
+    }
+```
 
 #### 返回结果
-```javascript
-
-{
-    "status": 0,
-    "msg": "success",
-}
-
+``` javascript
+    {
+        "status": 0,// 0为成功，2030为验证码错误，2060为重复登录，否则失败
+        "msg": "success",
+        "data": {
+            "userpin": "230ecdf3333944ff834f56fba10a02aa" //用户登录后的凭证，增、删、改、查、涉及用户的需要传递此值在请求头中
+        },
+        "requestId": "1b12b0e9c190436da000386ddf693c8f"
+    }
 ```
 
 
 
-## **<a name="getMenu"> 获取菜单</a>**
+## **<a name="userPinByRegister"> 用户注册</a>**
 [返回到目录](#menu)
 ##### URL
-[/web/auth/userCtl/getMenu]
+[/web/auth/accessAuth/springBoard]
 #### 参数格式  `JSON`
 #### HTTP请求方式 `POST`
+#### 渠道执行的类型 actionType：userPinByRegister
+``` javascript
+    {
+        "mobile":"15010929366", // Y 手机号
+        "vcode":"593555",   //  Y 验证码
+        "password":"123456" // Y 密码
+    }
+```
 
 #### 返回结果
-```javascript
-
-[
-    {
-        "name": "首页",
-        "path": "/",
-        "submenu": []
-    },
+``` javascript
     {
-        "name": "商户中心",
-        "path": "/merchants",
-        "submenu": [
-            {
-                "name": "客户管理",
-                "team": [
-                    {
-                        "name": "商户信息",
-                        "path": "/merchants/businessInformation"
-                    },
-                    ...
-                ]
-            }
-        ]
-    },
-    ...
-]
+        "status": 0,// 0为成功，2030为验证码错误，2060为重复登录，否则失败
+        "msg": "success",
+        "data": {
+            "userpin": "230ecdf3333944ff834f56fba10a02aa" //用户登录后的凭证，增、删、改、查、涉及用户的需要传递此值在请求头中
+        },
+        "requestId": "1b12b0e9c190436da000386ddf693c8f"
+    }
 ```