huayandong

update doc api

  1 +[![996.icu](https://img.shields.io/badge/link-996.icu-red.svg)](https://996.icu)
  2 +
  3 +
  4 +### 四会课程 小程序领取接口0719
  5 +
  6 +
  7 +##### 1. 微信用户登录,跟原来接口一样
  8 +
  9 +- URL: {{localhost}}/boxfish-online-card/wxUser/userLogin
  10 +- Method: POST
  11 +- RequestBody:
  12 +
  13 +```json
  14 +{
  15 + // 登录凭证
  16 + "jsCode": "wx_jsCode",
  17 + // 用户信息
  18 + "nickName": "user_nickName",
  19 + "avatarUrl":"user_avatarUrl"
  20 +}
  21 +```
  22 +
  23 +- ResponseBody:
  24 +
  25 +```json
  26 + // status
  27 + private ResponseStatus status;
  28 + private String message;
  29 + // body
  30 + private String openId;
  31 + private String wxToken;
  32 +```
  33 +
  34 +##### 2. 通过邀请码,建立邀请关系
  35 +
  36 +- URL: {{localhost}}/boxfish-online-card/wx_mini/addUserRelationship/v2
  37 +- Method: POST
  38 +- RequestBody:
  39 +
  40 +```json
  41 +{
  42 + "openId": "user_openId",
  43 + "invitationCode": "invitation_code"
  44 +}
  45 +```
  46 +
  47 +- ResponseBody:
  48 +
  49 +```java
  50 +public static class Response {
  51 + // status
  52 + private ResponseStatus status;
  53 + private String message;
  54 +
  55 + // 邀请人信息
  56 + private String invitationOpenId;
  57 + private String invitationNickName;
  58 + private String invitationAvatarUrl;
  59 +}
  60 +```
  61 +
  62 +##### 3. 用户查询领取信息接口
  63 +
  64 +- URL: {{localhost}}/boxfish-online-card/order/mini/getUserObtainSummary
  65 +- Method: POST
  66 +- RequestBody:
  67 +
  68 +```json5
  69 +{
  70 + "userOpenId": "open_id_userOpenId"
  71 +}
  72 +```
  73 +
  74 +- ResponseBody:
  75 +
  76 +```json5
  77 +{
  78 + "status": "SUCCESS",
  79 + "userObtainWordCourse": true,
  80 + "userObtainExperienceCourse": false,
  81 + "userType": "BUSINESS",
  82 + "invitationList": [
  83 + {
  84 + "openId":"invitation_openId",
  85 + "nickName": "张三",
  86 + "avatarUrl": "avatar_avatarUrl",
  87 + "flagPlaceOrder": true,
  88 + "orderTime": "2019-07-19 00:00:11"
  89 + }
  90 + ]
  91 +}
  92 +```
  93 +
  94 +
  95 +