api-config.json 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233
  1. {
  2. "name": "douyin-user-profile",
  3. "displayName": "抖音用户信息查询",
  4. "description": "根据 sec_user_id 获取抖音用户完整主页数据,包括粉丝数、总获赞数、作品数、个人简介、认证信息等。适用于KOL档案建立、竞品品牌账号分析、达人粉丝画像评估。",
  5. "category": "douyin",
  6. "version": "1.3.0",
  7. "endpoint": {
  8. "method": "GET",
  9. "url": "https://server.fmode.cn/api/voc-social/douyin/app/v3/handler_user_profile",
  10. "headers": {
  11. "Authorization": "Bearer ${vocToken}",
  12. "Accept": "application/json"
  13. }
  14. },
  15. "parameters": {
  16. "type": "object",
  17. "required": [
  18. "sec_user_id"
  19. ],
  20. "properties": {
  21. "sec_user_id": {
  22. "type": "string",
  23. "description": "抖音用户 sec_user_id"
  24. }
  25. }
  26. },
  27. "requestTransform": {
  28. "queryParams": {
  29. "sec_user_id": "{{sec_user_id}}"
  30. }
  31. },
  32. "response": {
  33. "type": "object",
  34. "description": "用户完整资料(双层包装:{code, data},用户数据在 data.user 内)",
  35. "note": "顶层 {code:200, data:{...}},data 内含 user 对象和 status_code。",
  36. "properties": {
  37. "code": {
  38. "type": "integer",
  39. "description": "HTTP 状态码(200=成功)"
  40. },
  41. "data": {
  42. "type": "object",
  43. "description": "业务数据包装层",
  44. "properties": {
  45. "user": {
  46. "type": "object",
  47. "description": "用户完整信息,含 uid、nickname、sec_uid、follower_count、total_favorited、aweme_count、signature 等"
  48. },
  49. "status_code": {
  50. "type": "integer",
  51. "description": "业务状态码(0=成功)"
  52. }
  53. }
  54. }
  55. },
  56. "keyFields": {
  57. "data.user.uid": "用户 ID",
  58. "data.user.nickname": "用户昵称",
  59. "data.user.sec_uid": "用户 sec_uid",
  60. "data.user.unique_id": "抵音号",
  61. "data.user.follower_count": "粉丝数",
  62. "data.user.total_favorited": "总获赞数",
  63. "data.user.aweme_count": "作品数",
  64. "data.user.signature": "个人简介",
  65. "data.user.verification_type": "认证类型",
  66. "data.user.ip_location": "IP 属地"
  67. }
  68. },
  69. "usageExamples": [
  70. {
  71. "name": "KOL达人档案建立",
  72. "input": {
  73. "sec_user_id": "MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y"
  74. },
  75. "description": "获取达人完整主页数据,建立KOL档案:粉丝规模、获赞总量、内容数量、个人定位"
  76. },
  77. {
  78. "name": "竞品品牌账号分析",
  79. "input": {
  80. "sec_user_id": "竞品品牌抖音sec_user_id"
  81. },
  82. "description": "分析竞品品牌抖音账号的粉丝规模、内容体量、账号认证状态"
  83. }
  84. ],
  85. "workflow": {
  86. "description": "推荐调用链",
  87. "steps": [
  88. "上游: douyin-user-search(keyword) → 搜索达人 → 取 sec_uid",
  89. "上游: douyin-general-search(keyword) → 获取视频列表 → 从 author.sec_uid 获取",
  90. "本步: douyin-user-profile(sec_user_id) → 获取完整账号数据",
  91. "下游: 结合粉丝数/获赞数评估KOL商业价值"
  92. ]
  93. },
  94. "reportMapping": {
  95. "slides": [
  96. "社媒聆听(Slide14)"
  97. ],
  98. "dataPoints": [
  99. "KOL粉丝规模",
  100. "账号总获赞(影响力指标)",
  101. "作品发布频率(活跃度)",
  102. "账号认证类型(品牌/个人/机构)",
  103. "达人个人定位(简介分析)"
  104. ]
  105. },
  106. "timeout": 60000,
  107. "retry": {
  108. "maxAttempts": 3,
  109. "delay": 1500,
  110. "backoffMultiplier": 2
  111. },
  112. "tokenConfig": {
  113. "type": "bearer",
  114. "configFile": "~/.openclaw/voc-credentials.json",
  115. "tokenField": "vocToken",
  116. "resolutionOrder": [
  117. "configFile"
  118. ],
  119. "apigId": "Vo3ROWEvDy",
  120. "paymentUrlResolution": {
  121. "description": "动态构建充值URL:在已存在 session token 时查出用户 objectId,拼接到专属充值页面",
  122. "steps": [
  123. "1. 从 voc-credentials.json 获取当前 session token",
  124. "2. 调用 GET https://server.fmode.cn/parse/users/me (Header: X-Parse-Application-Id: ncloudmaster, X-Parse-Session-Token: {token})获取用户 objectId",
  125. "3. 拼接充值URL: https://app.fmode.cn/dev/apig-pay/?user={objectId}&apigid=Vo3ROWEvDy&fun_id=HOkkX72PMF",
  126. "4. 将该URL展示给用户,引导扫码支付"
  127. ],
  128. "userResolveEndpoint": "https://server.fmode.cn/parse/users/me",
  129. "userResolveHeaders": {
  130. "X-Parse-Application-Id": "ncloudmaster",
  131. "X-Parse-Session-Token": "{vocToken}"
  132. },
  133. "paymentBaseUrl": "https://app.fmode.cn/dev/apig-pay/",
  134. "paymentParams": {
  135. "user": "{resolvedUserId}",
  136. "apigid": "Vo3ROWEvDy",
  137. "fun_id": "HOkkX72PMF"
  138. },
  139. "balanceCheckEndpoint": "https://server.fmode.cn/api/apig/getApig"
  140. },
  141. "onMissing": {
  142. "action": "showPaymentQR",
  143. "qrCodeUrl": "https://app.fmode.cn/dev/apig-pay/?apigid=Vo3ROWEvDy&fun_id=HOkkX72PMF",
  144. "title": "扫码开通 VOC-AI 数据服务",
  145. "message": "此 Skill 需要有效的 API Token。请先打开充值页面完成登录和充值;当用户提供 session token 后,请由 OpenClaw 运行 node scripts/tools/set-voc-token.js <session-token> 写入 ~/.openclaw/voc-credentials.json 的 vocToken 字段,再重试当前 Skill。",
  146. "tokenSetupCommandTemplate": "node scripts/tools/set-voc-token.js {sessionToken}",
  147. "tokenSetupInstructions": "当用户完成登录和充值后,如果用户把 session token 发给你,请直接运行 node scripts/tools/set-voc-token.js <session-token> 写入 ~/.openclaw/voc-credentials.json,然后重试当前 Skill。"
  148. },
  149. "onBalanceInsufficient": {
  150. "action": "resolveUserThenShowPayment",
  151. "title": "VOC-AI Token 余额不足,请扫码充值",
  152. "message": "当前 Token 余额不足,我将为你生成专属充值链接,扫码支付后即可继续使用。"
  153. }
  154. },
  155. "errorHandling": {
  156. "balanceInsufficient": {
  157. "conditions": [
  158. {
  159. "responseField": "code",
  160. "operator": "in",
  161. "value": [
  162. -2,
  163. -3,
  164. -10,
  165. 402,
  166. 429
  167. ]
  168. },
  169. {
  170. "responseField": "msg",
  171. "operator": "contains",
  172. "value": [
  173. "余额不足",
  174. "insufficient",
  175. "balance",
  176. "quota",
  177. "没有开通",
  178. "权限或余额"
  179. ]
  180. },
  181. {
  182. "responseField": "mess",
  183. "operator": "contains",
  184. "value": [
  185. "余额不足",
  186. "insufficient",
  187. "balance",
  188. "quota",
  189. "没有开通",
  190. "权限或余额"
  191. ]
  192. },
  193. {
  194. "responseField": "message",
  195. "operator": "contains",
  196. "value": [
  197. "余额不足",
  198. "insufficient",
  199. "balance",
  200. "没有开通",
  201. "权限或余额"
  202. ]
  203. }
  204. ],
  205. "matchMode": "any",
  206. "trigger": "tokenConfig.onBalanceInsufficient"
  207. },
  208. "unauthorized": {
  209. "conditions": [
  210. {
  211. "responseField": "code",
  212. "operator": "in",
  213. "value": [
  214. 401,
  215. 403
  216. ]
  217. },
  218. {
  219. "responseField": "msg",
  220. "operator": "contains",
  221. "value": [
  222. "unauthorized",
  223. "token",
  224. "invalid",
  225. "auth"
  226. ]
  227. }
  228. ],
  229. "matchMode": "any",
  230. "trigger": "tokenConfig.onMissing"
  231. }
  232. }
  233. }