ttj1314 / API-Interfaces · Commits

Go to a project

Authored by zhouxiang
Commit 707513f371fe3b07723b2fb79a7cc1b430dc2e34 1 parent ccea58f1

no message

Inline Side-by-side
Showing 2 changed files with 276 additions and 274 deletions
@@ -401,4 +401,279 @@ code为200即为成功，否则是失败。 @@ -401,4 +401,279 @@ code为200即为成功，否则是失败。
401 "md5": "6d729d4b35f10fc73531210bd7ecff91", 401 "md5": "6d729d4b35f10fc73531210bd7ecff91",
402 "message": "用户id不能为空." 402 "message": "用户id不能为空."
403 } 403 }
404 -```  
  404 +```
  405 +
  406 +## 4、同步用户到社区##
  407 +同步用户到社区（method=app.social.synCommunityUser）
  408 +
  409 +#### 公共请求参数
  410 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  411 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  412 +|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
  413 +|app_version|float|10|否|1||APP版本|
  414 +|os_version|string|20|否|Android4.4||系统版本+机器型号|
  415 +|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
  416 +|screen_size|string|20|否|800x900||（手机尺寸）|
  417 +
  418 +#### 请求参数
  419 +| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
  420 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  421 +|uid|int|1-11|否|8050840||ssouid或uid|
  422 +|clientType|String|1|否|1||客户端来源类型 1表示yohobuy其他客户端不需要传|
  423 +
  424 +#### 接口说明
  425 +| 接口说明||
  426 +|:-------| -----:|
  427 +|请求域名|http://api.yoho.cn|
  428 +|接口名|app.social.synCommunityUser|
  429 +|接口说明|4、同步用户到社区|
  430 +|http请求方式|POST/GET|
  431 +#### 返回错误
  432 +|错误code|错误提示|
  433 +|:-------| -----:|
  434 +|400| is null.|
  435 +
  436 +注意，通用的头部没有列出。
  437 +请求示例
  438 +http://192.168.102.205:8080/gateway/?method=app.social.synCommunityUser&uid=8050840&clientType=1
  439 +
  440 +### 响应
  441 +code为200即为成功，否则是失败。
  442 +响应参数，data部分
  443 +响应成功JSON格式如下所示:
  444 +```json
  445 +{
  446 + "alg": "SALT_MD5",
  447 + "code": 200,
  448 + "data": "8050839",
  449 + "md5": "ec74b07637f4c6e131752968b49827fd",
  450 + "message": "同步成功."
  451 +}
  452 +```
  453 +响应失败JSON格式如下所示:
  454 +```json
  455 +{
  456 + "alg": "SALT_MD5",
  457 + "code": 400,
  458 + "data": [],
  459 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  460 + "message": "uid is null."
  461 +}
  462 +```
  463 +## 5、获取用户信息##
  464 +获取用户信息（method=app.social.getUserInfo）
  465 +
  466 +#### 公共请求参数
  467 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  468 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  469 +|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
  470 +|app_version|float|10|否|1||APP版本|
  471 +|os_version|string|20|否|Android4.4||系统版本+机器型号|
  472 +|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
  473 +|screen_size|string|20|否|800x900||（手机尺寸）|
  474 +
  475 +#### 请求参数
  476 +| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
  477 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  478 +|uid|int|1-11|否|8050840||ssouid|
  479 +
  480 +#### 接口说明
  481 +| 接口说明||
  482 +|:-------| -----:|
  483 +|请求域名|http://api.yoho.cn|
  484 +|接口名|app.social.getUserInfo|
  485 +|接口说明|获取用户信息|
  486 +|http请求方式|POST/GET|
  487 +#### 返回错误
  488 +|错误code|错误提示|
  489 +|:-------| -----:|
  490 +|400|uid is null.|
  491 +|500|user info is null.|
  492 +
  493 +注意，通用的头部没有列出。
  494 +请求示例
  495 +http://192.168.102.205:8080/gateway/?method=app.social.getUserInfo&uid=8050840
  496 +
  497 +### 响应
  498 +code为200即为成功，否则是失败。
  499 +响应参数，data部分
  500 +响应成功JSON格式如下所示:
  501 +```json
  502 +{
  503 + "alg": "SALT_MD5",
  504 + "code": 200,
  505 + "data": {
  506 + "age": 18,
  507 + "birthday": "2015-12-26",
  508 + "createTime": 1467870980,
  509 + "gender": "1",
  510 + "headIco": "http://img10.static.yhbimg.com/yhb-img01/2016/06/28/17/01b4ab5ad41e5b2d1106915828f41c4bc6.jpg",
  511 + "height": 175,
  512 + "income": 10,
  513 + "nickName": "MayDay_1998_NMD_",
  514 + "profession": 1,
  515 + "realName": "Jay",
  516 + "signature": "",
  517 + "uid": 8050839,
  518 + "updateTime": 1467960902,
  519 + "weight": 60
  520 + },
  521 + "md5": "6938762e04e79d7726aa8cacd4962869",
  522 + "message": "获取用户信息成功"
  523 +}
  524 +```
  525 +响应失败JSON格式如下所示:
  526 +```json
  527 +{
  528 + "alg": "SALT_MD5",
  529 + "code": 400,
  530 + "data": [],
  531 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  532 + "message": "uid is null"
  533 +}
  534 +```
  535 +```json
  536 +{
  537 + "alg": "SALT_MD5",
  538 + "code": 500,
  539 + "data": [],
  540 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  541 + "message": "user info is null"
  542 +}
  543 +```
  544 +
  545 +## 6、获取用户信息##
  546 +获取用户信息（method=app.social.updateUserInfo）
  547 +
  548 +#### 公共请求参数
  549 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  550 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  551 +|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
  552 +|app_version|float|10|否|1||APP版本|
  553 +|os_version|string|20|否|Android4.4||系统版本+机器型号|
  554 +|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
  555 +|screen_size|string|20|否|800x900||（手机尺寸）|
  556 +
  557 +#### 请求参数
  558 +| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
  559 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  560 +|uid|int|1-11|否|8050839||ssouid|
  561 +|signature|int|1-50|否|来有货玩潮流！领NMD!||签名|
  562 +|headIco|int|1-50|否|/2016/06/28/17/01b4ab5ad41e5b2d1106915828f41c4bc6.jpg||头像|
  563 +|nickName|int|1-20|否|JAY||昵称|
  564 +
  565 +#### 接口说明
  566 +| 接口说明||
  567 +|:-------| -----:|
  568 +|请求域名|http://api.yoho.cn|
  569 +|接口名|app.social.updateUserInfo|
  570 +|接口说明|获取用户信息|
  571 +|http请求方式|POST/GET|
  572 +#### 返回错误
  573 +|错误code|错误提示|
  574 +|:-------| -----:|
  575 +|400|uid is null.|
  576 +|405更新用户信息失败,昵称重复.|
  577 +|500|更新用户信息失败.|
  578 +
  579 +注意，通用的头部没有列出。
  580 +请求示例
  581 +http://192.168.102.205:8080/gateway/?method=app.social.updateUserInfo&uid=8050839&signature=来有货玩潮流！领NMD!&headIco=http://img10.static.yhbimg.com/yhb-img01/2016/06/28/17/01b4ab5ad41e5b2d1106915828f41c4bc6.jpg&nickName=MayDay_1998_NMD
  582 +
  583 +### 响应
  584 +code为200即为成功，否则是失败。
  585 +响应参数，data部分
  586 +响应成功JSON格式如下所示:
  587 +```json
  588 +{
  589 + "alg": "SALT_MD5",
  590 + "code": 200,
  591 + "data": [],
  592 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  593 + "message": "更新用户信息成功"
  594 +}
  595 +```
  596 +响应失败JSON格式如下所示:
  597 +```json
  598 +{
  599 + "alg": "SALT_MD5",
  600 + "code": 400,
  601 + "data": [],
  602 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  603 + "message": "uid is null"
  604 +}
  605 +```
  606 +```json
  607 +{
  608 + "alg": "SALT_MD5",
  609 + "code": 405,
  610 + "data": [],
  611 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  612 + "message": "更新用户信息失败,昵称重复."
  613 +}
  614 +```
  615 +```json
  616 +{
  617 + "alg": "SALT_MD5",
  618 + "code": 405,
  619 + "data": [],
  620 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  621 + "message": "更新用户信息失败."
  622 +}
  623 +```
  624 +## 7、获取个人中心消息数##
  625 +获取个人中心消息数（method=app.social.getTotal）
  626 +
  627 +#### 公共请求参数
  628 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  629 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  630 +|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
  631 +|app_version|float|10|否|1||APP版本|
  632 +|os_version|string|20|否|Android4.4||系统版本+机器型号|
  633 +|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
  634 +|screen_size|string|20|否|800x900||（手机尺寸）|
  635 +
  636 +#### 请求参数
  637 +| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
  638 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  639 +|uid|String|1-11|否|8050839||ssouid|
  640 +|is_read|String|1|是|N|N|是否已读|
  641 +
  642 +#### 接口说明
  643 +| 接口说明||
  644 +|:-------| -----:|
  645 +|请求域名|http://api.yoho.cn|
  646 +|接口名|app.social.getTotal|
  647 +|接口说明|获取个人中心消息数|
  648 +|http请求方式|POST/GET|
  649 +#### 返回错误
  650 +|错误code|错误提示|
  651 +|:-------| -----:|
  652 +|400|uid is null.|
  653 +
  654 +注意，通用的头部没有列出。
  655 +请求示例
  656 +http://192.168.102.205:8080/gateway/?method=app.social.getTotal&uid=8050426&is_read=N
  657 +
  658 +### 响应
  659 +code为200即为成功，否则是失败。
  660 +响应参数，data部分
  661 +响应成功JSON格式如下所示:
  662 +```json
  663 +{
  664 + "alg": "SALT_MD5",
  665 + "code": 200,
  666 + "data": {
  667 + "total": "10"
  668 + },
  669 + "md5": "9f90870b7e9b81c25e0fe0781239409a",
  670 + "message": "查询未读消息数成功."
  671 +}
  672 +```
  673 +响应失败JSON格式如下所示:
  674 +```json
  675 +{
  676 + "message": "uid is null",
  677 + "code": 400
  678 +}
  679 +```
@@ -593,279 +593,6 @@ code为200即为成功，否则是失败。 @@ -593,279 +593,6 @@ code为200即为成功，否则是失败。
593 "message": "帖子id不能为空." 593 "message": "帖子id不能为空."
594 } 594 }
595 ``` 595 ```
596 -## 4、同步用户到社区##  
597 -同步用户到社区（method=app.social.synCommunityUser）  
598 596
599 -#### 公共请求参数  
600 -| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |  
601 -|:-------| -----:|-----:|-----:|-----:|-----:|----:|  
602 -|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|  
603 -|app_version|float|10|否|1||APP版本|  
604 -|os_version|string|20|否|Android4.4||系统版本+机器型号|  
605 -|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|  
606 -|screen_size|string|20|否|800x900||（手机尺寸）|  
607 -  
608 -#### 请求参数  
609 -| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |  
610 -|:-------| -----:|-----:|-----:|-----:|-----:|----:|  
611 -|uid|int|1-11|否|8050840||ssouid或uid|  
612 -|clientType|String|1|否|1||客户端来源类型 1表示yohobuy其他客户端不需要传|  
613 -  
614 -#### 接口说明  
615 -| 接口说明||  
616 -|:-------| -----:|  
617 -|请求域名|http://api.yoho.cn|  
618 -|接口名|app.social.synCommunityUser|  
619 -|接口说明|4、同步用户到社区|  
620 -|http请求方式|POST/GET|  
621 -#### 返回错误  
622 -|错误code|错误提示|  
623 -|:-------| -----:|  
624 -|400| is null.|  
625 -  
626 -注意，通用的头部没有列出。  
627 -请求示例  
628 -http://192.168.102.205:8080/gateway/?method=app.social.synCommunityUser&uid=8050840&clientType=1  
629 -  
630 -### 响应  
631 -code为200即为成功，否则是失败。  
632 -响应参数，data部分  
633 -响应成功JSON格式如下所示:  
634 -```json  
635 -{  
636 - "alg": "SALT_MD5",  
637 - "code": 200,  
638 - "data": "8050839",  
639 - "md5": "ec74b07637f4c6e131752968b49827fd",  
640 - "message": "同步成功."  
641 -}  
642 -```  
643 -响应失败JSON格式如下所示:  
644 -```json  
645 -{  
646 - "alg": "SALT_MD5",  
647 - "code": 400,  
648 - "data": [],  
649 - "md5": "6d729d4b35f10fc73531210bd7ecff91",  
650 - "message": "uid is null."  
651 -}  
652 -```  
653 -## 5、获取用户信息##  
654 -获取用户信息（method=app.social.getUserInfo）  
655 -  
656 -#### 公共请求参数  
657 -| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |  
658 -|:-------| -----:|-----:|-----:|-----:|-----:|----:|  
659 -|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|  
660 -|app_version|float|10|否|1||APP版本|  
661 -|os_version|string|20|否|Android4.4||系统版本+机器型号|  
662 -|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|  
663 -|screen_size|string|20|否|800x900||（手机尺寸）|  
664 -  
665 -#### 请求参数  
666 -| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |  
667 -|:-------| -----:|-----:|-----:|-----:|-----:|----:|  
668 -|uid|int|1-11|否|8050840||ssouid|  
669 -  
670 -#### 接口说明  
671 -| 接口说明||  
672 -|:-------| -----:|  
673 -|请求域名|http://api.yoho.cn|  
674 -|接口名|app.social.getUserInfo|  
675 -|接口说明|获取用户信息|  
676 -|http请求方式|POST/GET|  
677 -#### 返回错误  
678 -|错误code|错误提示|  
679 -|:-------| -----:|  
680 -|400|uid is null.|  
681 -|500|user info is null.|  
682 -  
683 -注意，通用的头部没有列出。  
684 -请求示例  
685 -http://192.168.102.205:8080/gateway/?method=app.social.getUserInfo&uid=8050840  
686 -  
687 -### 响应  
688 -code为200即为成功，否则是失败。  
689 -响应参数，data部分  
690 -响应成功JSON格式如下所示:  
691 -```json  
692 -{  
693 - "alg": "SALT_MD5",  
694 - "code": 200,  
695 - "data": {  
696 - "age": 18,  
697 - "birthday": "2015-12-26",  
698 - "createTime": 1467870980,  
699 - "gender": "1",  
700 - "headIco": "http://img10.static.yhbimg.com/yhb-img01/2016/06/28/17/01b4ab5ad41e5b2d1106915828f41c4bc6.jpg",  
701 - "height": 175,  
702 - "income": 10,  
703 - "nickName": "MayDay_1998_NMD_",  
704 - "profession": 1,  
705 - "realName": "Jay",  
706 - "signature": "",  
707 - "uid": 8050839,  
708 - "updateTime": 1467960902,  
709 - "weight": 60  
710 - },  
711 - "md5": "6938762e04e79d7726aa8cacd4962869",  
712 - "message": "获取用户信息成功"  
713 -}  
714 -```  
715 -响应失败JSON格式如下所示:  
716 -```json  
717 -{  
718 - "alg": "SALT_MD5",  
719 - "code": 400,  
720 - "data": [],  
721 - "md5": "6d729d4b35f10fc73531210bd7ecff91",  
722 - "message": "uid is null"  
723 -}  
724 -```  
725 -```json  
726 -{  
727 - "alg": "SALT_MD5",  
728 - "code": 500,  
729 - "data": [],  
730 - "md5": "6d729d4b35f10fc73531210bd7ecff91",  
731 - "message": "user info is null"  
732 -}  
733 -```  
734 -  
735 -## 6、获取用户信息##  
736 -获取用户信息（method=app.social.updateUserInfo）  
737 -  
738 -#### 公共请求参数  
739 -| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |  
740 -|:-------| -----:|-----:|-----:|-----:|-----:|----:|  
741 -|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|  
742 -|app_version|float|10|否|1||APP版本|  
743 -|os_version|string|20|否|Android4.4||系统版本+机器型号|  
744 -|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|  
745 -|screen_size|string|20|否|800x900||（手机尺寸）|  
746 -  
747 -#### 请求参数  
748 -| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |  
749 -|:-------| -----:|-----:|-----:|-----:|-----:|----:|  
750 -|uid|int|1-11|否|8050839||ssouid|  
751 -|signature|int|1-50|否|来有货玩潮流！领NMD!||签名|  
752 -|headIco|int|1-50|否|/2016/06/28/17/01b4ab5ad41e5b2d1106915828f41c4bc6.jpg||头像|  
753 -|nickName|int|1-20|否|JAY||昵称|  
754 -  
755 -#### 接口说明  
756 -| 接口说明||  
757 -|:-------| -----:|  
758 -|请求域名|http://api.yoho.cn|  
759 -|接口名|app.social.updateUserInfo|  
760 -|接口说明|获取用户信息|  
761 -|http请求方式|POST/GET|  
762 -#### 返回错误  
763 -|错误code|错误提示|  
764 -|:-------| -----:|  
765 -|400|uid is null.|  
766 -|405更新用户信息失败,昵称重复.|  
767 -|500|更新用户信息失败.|  
768 -  
769 -注意，通用的头部没有列出。  
770 -请求示例  
771 -http://192.168.102.205:8080/gateway/?method=app.social.updateUserInfo&uid=8050839&signature=来有货玩潮流！领NMD!&headIco=http://img10.static.yhbimg.com/yhb-img01/2016/06/28/17/01b4ab5ad41e5b2d1106915828f41c4bc6.jpg&nickName=MayDay_1998_NMD  
772 -  
773 -### 响应  
774 -code为200即为成功，否则是失败。  
775 -响应参数，data部分  
776 -响应成功JSON格式如下所示:  
777 -```json  
778 -{  
779 - "alg": "SALT_MD5",  
780 - "code": 200,  
781 - "data": [],  
782 - "md5": "6d729d4b35f10fc73531210bd7ecff91",  
783 - "message": "更新用户信息成功"  
784 -}  
785 -```  
786 -响应失败JSON格式如下所示:  
787 -```json  
788 -{  
789 - "alg": "SALT_MD5",  
790 - "code": 400,  
791 - "data": [],  
792 - "md5": "6d729d4b35f10fc73531210bd7ecff91",  
793 - "message": "uid is null"  
794 -}  
795 -```  
796 -```json  
797 -{  
798 - "alg": "SALT_MD5",  
799 - "code": 405,  
800 - "data": [],  
801 - "md5": "6d729d4b35f10fc73531210bd7ecff91",  
802 - "message": "更新用户信息失败,昵称重复."  
803 -}  
804 -```  
805 -```json  
806 -{  
807 - "alg": "SALT_MD5",  
808 - "code": 405,  
809 - "data": [],  
810 - "md5": "6d729d4b35f10fc73531210bd7ecff91",  
811 - "message": "更新用户信息失败."  
812 -}  
813 -```  
814 -## 7、获取个人中心消息数##  
815 -获取个人中心消息数（method=app.social.getTotal）  
816 -  
817 -#### 公共请求参数  
818 -| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |  
819 -|:-------| -----:|-----:|-----:|-----:|-----:|----:|  
820 -|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|  
821 -|app_version|float|10|否|1||APP版本|  
822 -|os_version|string|20|否|Android4.4||系统版本+机器型号|  
823 -|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|  
824 -|screen_size|string|20|否|800x900||（手机尺寸）|  
825 -  
826 -#### 请求参数  
827 -| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |  
828 -|:-------| -----:|-----:|-----:|-----:|-----:|----:|  
829 -|uid|String|1-11|否|8050839||ssouid|  
830 -|is_read|String|1|是|N|N|是否已读|  
831 -  
832 -#### 接口说明  
833 -| 接口说明||  
834 -|:-------| -----:|  
835 -|请求域名|http://api.yoho.cn|  
836 -|接口名|app.social.getTotal|  
837 -|接口说明|获取个人中心消息数|  
838 -|http请求方式|POST/GET|  
839 -#### 返回错误  
840 -|错误code|错误提示|  
841 -|:-------| -----:|  
842 -|400|uid is null.|  
843 -  
844 -注意，通用的头部没有列出。  
845 -请求示例  
846 -http://192.168.102.205:8080/gateway/?method=app.social.getTotal&uid=8050426&is_read=N  
847 -  
848 -### 响应  
849 -code为200即为成功，否则是失败。  
850 -响应参数，data部分  
851 -响应成功JSON格式如下所示:  
852 -```json  
853 -{  
854 - "alg": "SALT_MD5",  
855 - "code": 200,  
856 - "data": {  
857 - "total": "10"  
858 - },  
859 - "md5": "9f90870b7e9b81c25e0fe0781239409a",  
860 - "message": "查询未读消息数成功."  
861 -}  
862 -```  
863 -响应失败JSON格式如下所示:  
864 -```json  
865 -{  
866 - "message": "uid is null",  
867 - "code": 400  
868 -}  
869 -```  
870 597
871 598