docs / developer-docs

Go to a project
Toggle navigation Toggle navigation pinning
chong
efb3fa08 1 parent b481de6a

扫码登录

Inline Side-by-side
Showing 2 changed files with 96 additions and 1 deletions
@@ -14,6 +14,7 @@ @@ -14,6 +14,7 @@
14 14
15 | 变量名 | 类型 | 必填 | 说明 | 示例 | 15 | 变量名 | 类型 | 必填 | 说明 | 示例 |
16 |-------------|--------|------|----------|------| 16 |-------------|--------|------|----------|------|
  17 + | learning | Object | Y | 学情 | |
17 | unfinished | List | Y | 未完成学生列表 | | 18 | unfinished | List | Y | 未完成学生列表 | |
18 | finished | List | Y | 已完成学生列表| | 19 | finished | List | Y | 已完成学生列表| |
19 20
@@ -33,6 +34,7 @@ @@ -33,6 +34,7 @@
33 34
34 ```json 35 ```json
35 { 36 {
  37 + "learning": {
36 "unfinished": [{ 38 "unfinished": [{
37 "user_id": 9200, 39 "user_id": 9200,
38 "user_real_name": "吕寰", 40 "user_real_name": "吕寰",
@@ -56,7 +58,8 @@ @@ -56,7 +58,8 @@
56 } 58 }
57 ] 59 ]
58 }] 60 }]
59 - } 61 + }
  62 +}
60 ``` 63 ```
61 64
62 ## 用户规划课程接口 65 ## 用户规划课程接口
  1 +> env.url: `https`://api[api-online.test].boxfish.cn
  2 +>
  3 +> notes:
  4 +>
  5 + * `默认所有接口都要携带token` access_token
  6 +
  7 +# TV扫码登录
  8 +## 获取登录二维码
  9 + * URL {env.url}/qrcode
  10 + * `GET` Method
  11 + * path 参数: 无token
  12 + * request 参数:
  13 + * response：
  14 +
  15 + http code 200
  16 +
  17 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  18 + |-------------|--------|------|----------|------|
  19 + | uuid | String | Y |二维码唯一标示| |
  20 + | qrcode| String | Y | base64 二维码||
  21 +```json
  22 +{
  23 + "uuid": "n9107fXmT46dT_9oYiR-3w",
  24 + "qrcode": "iVBORw0KGgoAAAANSUhEUgAAAQ4AAAEOCAYAAAB4sfmlAAAGQElEQVR42u3dS27bUBREQe5/0/YaDFhUd986QIZMxPepDPQoPj+S9MceQyAJHJLAIQkcksAhCRySBA5J4JAEDkngkAQOSQKHJHBIAockcEgChySBQxI4JIFDEjgkgUMSOCQJHJLAIQkcksAhCRySBA5J4JAEDkngkAQOSUqF43me+j+fuPe3x3ph3q0zcIADHOAAhwkFBzjAAQ5wgAMc4AAHOMABDnCAwzoDBzjAAQ5wxC7mT3zOpE2Q9HcmzcPCOgMHOMABDnCAAxzgAAc4wAEOcBgocIADHOAABzjAAQ5wgAMc4AjYkC2b4PKZkqT5W1hn4AAHOMABDnCAAxzgAAc4wAEOcIADHOAABzjAAQ5wgAMc4ADH6IS2fJa37yFpvYADHOAABzjAAQ5wgAMc4AAHOMABDnCAAxzgAAc4wAEOcIADHOA4NaELG2T9cXxwgAMc4AAHOMABDusMHOAABzjAYULBAQ5wgAMc4AAHOMABDnCMwrEA3PrmWYDYfgAHOMABDnCAAxzWGTjAAQ5wgMOEggMc4AAHOMBhP4ADHOAAxygcLX8WwLl83cI6Awc4XAcOcIDDdeAABzhsSHCAAxzgcB04wAEO14EDHOBwHTjAodhzAOsvuRY4BA6BQ+AABzgEDnCAQ+AAh8ABDnAIHAKHDsKxcB5j/XMm4XD5rA04bEhwgAMc4AAHOMABDp8THOAABzjAAQ5wgAMc4AAHOMABDnCMwrG+gNZfVu2xenCAAxzgAAc4wAEOcIADHOAABzjAAQ5wgAMc4AAHOMABDnAchCPq++mgxbywQZKAS0Kzfp+gAhzgAAc4wAEOcIADHOAABzjAAQ5wgAMc4AAHOAQOcICjBY7178IXzqK0bAKP1YMDHOAABzjAAQ5wgAMc4AAHOMDh/sABDnCAAxzgAAc4wAEOcHx1MSddt7BgF85xLCAGDnCAAxzgAAc4wAEOcIADHOAABzjAAQ5wgAMc4AAHOMABDnCEb8jLwCWNtReDgwMc4AAHOMABDnCAAxzgAAc4wAEOcIADHOAABzjAAQ5wgAMcp1DxYmm/cr4GADjAAQ5wgAMc4AAHOMABDnCAAxzgAAc4wAEOcIADHOAABzhOw2FD5kO1/kvfznGAAxzgAAc4wAEOcIADHOAABzjAAQ5wgAMc4AAHOMABDnCAAxyxj3q3LMqk+7v8svGKvQcOcIADHOAABzjAAQ5wgAMc4AAHOMABDnCAAxzgAAc4wAGOFjh8T7471m8jvfBL5s5xgAMc4AAHOMABDnCAAxzgAAc4wAEOcIADHOAABzjAAQ5wgOOlxZz0711+yfXC2YmWtVTxHxA4wAEOcIADHOAABzjAAQ5wgAMc4LCWwGGywQEOcIADHOAABzgy7qEFKo/c548LOMABDnCAAxzgAAc4wAEOcIADHOAABzjAAQ5wgAMc4AAHOMDx0kC1LJKFF0u3AOCxenCAAxzgAAc4wAEOcIADHOAABzjAAQ5wgAMc4AAHOMABDnCA41QLj9wbzwxwwAEOcIADHAKH8QSHwGE8wQEOCx0c4AAHOMABDnCAAxzgAEfAxLR8n//2Arr8KPvC/IEDHOAABzjAAQ5wgAMc4AAHOMABDnCAAxzgAAc4wAEOcIADHP+4mKMGy8uxIz6nczHgAAc4wAEOcIADHOAABzjAAQ5wgAMc4AAHOMABDnCAAxzgAMfcwmv5Pj/p/tbPorSMGTjAAQ5wgAMc4AAHOMABDnCAAxzgAAc4wAEOcIADHOAABzjAcRCOhTMsC+OZtAbBAQ5wgAMc4AAHOMABDnCAAxzgAAc4wAEOcIADHOAABzjAAQ5wVP5a+dtztIDfVRzAAQ5wgAMc4AAHOMABDnCAAxzgAAc4wAEOcIADHOAABzjAcRqOy8C1PK6+MJ5J9w4OcIADHOAABzjAAQ5wgAMc4AAHOMABDnCAAxzgAAc4wAEOcAQs2IVF4sXLGZ/z6lkNcIADHOAABzjAAQ5wgAMc4AAHOMABDnCAAxzgAAc4wAEOcEzAIQkcksAhSeCQBA5J4JAEDkngkCRwSAKHJHBIAockcEgChySBQxI4JIFDEjgkgUOSwCEJHJLAIQkcksAhSeCQBA5J4JAEDkngkAQOSQKHJHBIAockcEg62C/MkwGk1QZnPwAAAABJRU5ErkJggg=="
  25 +}
  26 +```
  27 +
  28 +## 扫描二维码
  29 + * URL {env.url}/scan/login
  30 + * `POST` Method
  31 + * path 参数:
  32 + * request 参数:
  33 +
  34 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  35 + |-------------|--------|------|----------|------|
  36 + | uuid| String | Y | 二维码中识别的uuid| true,false |
  37 + | type| String | Y |扫描二维码| scan |
  38 + * response：
  39 + http code 200
  40 +
  41 +## 扫描后确认登录
  42 + * URL {env.url}/scan/login
  43 + * `POST` Method
  44 + * path 参数:
  45 + * request 参数:
  46 +
  47 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  48 + |-------------|--------|------|----------|------|
  49 + | uuid| String | Y | 二维码中识别的uuid||
  50 + | type| String | Y |使用二维码登录| login |
  51 +
  52 + * response：
  53 +
  54 + http code 200
  55 +
  56 +## TV登录 （轮询）
  57 + * URL {env.url}/qrcode/login
  58 + * `GET` Method
  59 + * path 参数:
  60 + * request 参数:
  61 +
  62 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  63 + |-------------|--------|------|----------|------|
  64 + | uuid| String | Y |uuid||
  65 +
  66 +* response：
  67 +
  68 + http code 404 继续轮询
  69 +
  70 + http code 200 进入页面
  71 +
  72 + |参数名 | 类型 | 必填 | 说明 | 示例 |
  73 + |-------------|--------|------|----------|------|
  74 + | id| Long | Y |用户ID||
  75 + | uuid| String | Y | uuid ||
  76 + | status| String | Y |二维码状态||
  77 + | access_token| String | Y |用户token||
  78 + | qCloud.identifier| String | Y |腾讯云账号||
  79 + | qCloud.sign| String | Y ||腾讯云签名|
  80 +```json
  81 + {
  82 + "id": 7566,
  83 + "uuid": "n9107fXmT46dT_9oYiR-3w",
  84 + "status": "LOGIN",
  85 + "qCloud": {
  86 + "identifier": "a4cffc0652278de70dc2b3f374497358",
  87 + "sign": "eJxFkMtugzAURP*FbarGT3AqdRHxUGhALWr63CCDbWqlAWKcNCjqvxdQom7n3NGdmbOzSZ5vedtqkXObYyOcOwc4N5MsT602MufKSjPIkFKKALjSozSdbuoBIAApRBiAf6iFrK1WejJyUipVApci5DEhPSBKVGCFPUIWHqbs4ul0NRyn4YsfZ34fpipKGf*cQ7ZbvWXV4VEG78WDwjOK9sbEBeTHhK2f2DKu-Gq-9bLFT-j9BddLtQlYH80jArtVDEUXfNRNWp9m8DXx4-vrM7HNp9pjMTImJ5jSC7R6J0fdBdQFCKNrQl6WzaG2ue1bOe30*wdot1zA"
  88 + },
  89 + "access_token": "jc2yiAET0C"
  90 + }
  91 +```
  92 +