产品注册

接口功能概述

移动产品、ERP产品可以将产品注册到服务云对应的租户,便于运维自动初始化监控。

接口说明

  • 授权说明

    需要授权 身份认证2.0

  • 调用地址

    正式:https://zenith.fdcyun.com/v20/api/pub/product/register.svc
    测试:https://planet-test.fdcyun.com/v20/api/pub/product/register.svc
    
  • 调用方式:POST

  • 请求头信息(header)
x-token:xxxxx //调用服务云[认证接口]得到的token,未传输此头的请求无法获取数据
x-custid:xxxx //客户主数据GUID
SaaS产品:
[{
    "Name":"移动审批",//移动计划等产品 必填
    "Version":"1.0", 
    "KhGuid":"",//客户主数据guid 用以匹配服务云租户 
    "KhGuidTop":"",//客户主数的顶级GUID 
    "AppId":"YDSP",//可选 代其他产品注册 强烈不建议使用
    "Category":1,//1 ERP  2 云助手 其他产品接入时分配枚举
    "AliveUrl":"https://vank.fdcyun.com/", //可自定义,用于检测某个客户的系统是否可用,检测内容自定义,但需要返回固定的结构,具体参照奇峰之前发布的标准 
    "SubsystemInfos":[  //支持移动产品按子系统 进行数据、应用巡检
        {
            "Name":"移动计划",  //子系统名称
            "Code":"0323",     //子系统编码
            "Version":"1.0",    //子系统版本
            "DllName":"1.0"     //子系统dll版本
        }
    ]
}]

于AliveUrl的补述见 详情

Response Body

成功返回,http状态码为 200

//成功返回 lastInsertId / lastUpdateId 如:
1024

失败返回,http状态码为 500

{
    "Message": "应用ID不存在",
    "ExceptionType":"System.Exception",
    "xxx": "xxx" //后续扩展
}

其他http状态码说明

代码 说明
200 请求成功
403 未授权
500 具体错误信息,如:没有产品信息

更新说明

  1. 20190412 第1版。
  2. 20190415 第2版,相同AppId、相同Version、相同Name视为统一个产品,如果第二次调用,则会进行其他字段修改。
  3. 20190507 第3版,修改body部分结构说明
  4. 20190524 第4版,body增加 "KhGuid":"",//客户主数据guid 用以匹配服务云租户 "KhGuidTop":
  5. 20211115 第5版,body增加 "SubsystemInfos":[""],//支持移动产品注册时,同步新增相关子系统信息-- modified by yangmc