帮助手册

标签服务

 

  1.     本服务是一个微服务demo实例，可为各类资源打上标签，从不同维度对资源进行分类、搜索和聚合，以便轻松管理资源。
  2.  
  3. 标签API 1.0版
  4.     本服务提供的API接口，遵循REST体系结构
  5.     服务地址：tag.frmstock.org.cn
  6.     通信协议：https
  7.     请求方法：POST（推荐）、GET
  8.     字符编码：UTF-8
  9.  
  10. 1、开通指南
  11.     登录网站(www.frmstock.org.cn)，进入标签服务页面，进行开通。
  12.     开通后可获取两个值AppId和AccessKey，此为登录凭证，必须妥善保管，避免泄露。
  13.  
  14.     AppId     ：用于标识 API 调用者身份，可以简单类比为用户名。
  15.     AccessKey ：用于验证 API 调用者的身份，可以简单类比为密码。
  16.  
  17. 2、签名算法
  18.     1).拼接待签名字符串，伪代码如下：
  19.     stringToSign = AccessKey:timestamp:url
  20.  
  21.     AccessKey ：用于验证 API 调用者的身份，可以简单类比为密码。
  22.     timestamp ：当前时间戳。
  23.     url       ：请求地址。
  24.  
  25.     2).计算签名，伪代码如下：
  26.     authorization = md5sum(stringToSign)
  27.  
  28.     3).最终完整的调用信息如下：
  29.        GET /index.php/api/v1.token/beatheart HTTP/1.1
  30.        User-Agent: curl/7.29.0
  31.        Host: 127.0.0.1:8080
  32.        Accept: */*
  33.        authorization: fec4868ca0d503ac9ee7ce1440136076
  34.        timestamp: 1683250719
  35.        Cookie: PHPSESSID=885f1933601e0334846c2d5b29235d3a;
  36.  
  37. 3、登录心跳
  38.     1).登录，获取会话session，API的调用都是基于会话的
  39.     URL地址 ：/api/v1.auth/login
  40.     请求方法：POST
  41.  
  42.     密码计算方法：
  43.     password = md5sum(AccessKey:timestamp)
  44.  
  45.     AccessKey ：用于验证 API 调用者的身份，可以简单类比为密码。
  46.     timestamp ：当前时间戳。
  47.  
  48.     最终完整的调用信息如下：
  49.        POST /index.php/api/v1.auth/login HTTP/1.1
  50.        User-Agent: curl/7.29.0
  51.        Host: 127.0.0.1:8080
  52.        Accept: */*
  53.        timestamp: 1683250654
  54.        Content-Length: 84
  55.  
  56.     示例
  57.  
  58.     2).登录保活30分钟，超时自动退出，若无交互需发心跳包
  59.     URL地址 ：/api/v1.token/beatheart
  60.     请求方法：GET
  61.  
  62.     最终完整的调用信息如下：
  63.        GET /index.php/api/v1.token/beatheart HTTP/1.1
  64.        User-Agent: curl/7.29.0
  65.        Host: 127.0.0.1:8080
  66.        Accept: */*
  67.        authorization: fec4868ca0d503ac9ee7ce1440136076
  68.        timestamp: 1683250654
  69.        Cookie: PHPSESSID=885f1933601e0334846c2d5b29235d3a;
  70.  
  71.     示例
  72.  
  73. 4、接口说明
  74.     标签管理接口6个：
  75.     /api/v1.tag_mgr/getList : 获取标签列表               示例
  76.     /api/v1.tag_mgr/getTag  : 获取某标签关联的所有资源     示例
  77.     /api/v1.tag_mgr/getTags : 获取多个标签关联的所有资源     示例
  78.     /api/v1.tag_mgr/add     : 添加标签                       示例
  79.     /api/v1.tag_mgr/del     : 删除一个标签                   示例
  80.     /api/v1.tag_mgr/dels    : 删除多个标签                  示例
  81.  
  82.     资源过滤信息接口1个：
  83.     /api/v1.asset_mgr/updateField : 更新资源过滤字段属性值                    示例
  84.  
  85.     关联信息接口4个
  86.     /api/v1.tag_asset_mgr/getListByAsset  : 获取某一资源所关联的所有标签         示例
  87.     /api/v1.tag_asset_mgr/getListByAssets : 获取某些资源所关联的所有标签         示例
  88.     /api/v1.tag_asset_mgr/addRelation     : 为某一资源添加一个标签               示例
  89.     /api/v1.tag_asset_mgr/delRelation     : 删除某一资源的某一标签               示例
  90.