api-config.json 6.5 KB

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