公开API服务模板支持创建一个无需鉴权和SDK即可调用的API。本文介绍公开API模板服务的使用方法。

背景信息

  • 公开API服务为公开API,不需要使用AppKey和AppSecret鉴权即可直接通过HTTP接口调用。
  • 公开API服务创建完成后,不支持修改为需要AppKey鉴权的API了。
  • 公开API可以用于更简单的物联网能力输出。
注意
  • 通过公开API模板创建的API服务,无需任何鉴权,即支持通过HTTP接口直接调用。
  • 公开API服务的返回数据是公开的,即数据有严重的泄露风险。为确保您数据的安全性,请您谨慎使用和配置公开API服务。

创建公开API模板业务服务

  1. 在项目列表中,定位到目标项目,单击项目右侧操作栏的进入
  2. 在项目的主页选择业务服务页签。
    项目中新建业务服务
  3. 单击业务服务列表左上方的新建,选择从模板新建
  4. 业务逻辑开发页面,定位并单击公开API模板。
  5. 在右侧的从模板创建业务逻辑页面,配置服务基本信息。
    公开API
    参数 说明
    服务名称 自定义服务名称。

    可包含中文汉字、英文字母、数字和下划线(_),长度不超过20个字符(一个中文汉字算一个字符)。

    所属项目 显示服务所属的项目。
    描述 描述服务的用途等信息。长度不超过100个字符(一个中文汉字算一个字符)。
  6. 单击使用该模板新建
    业务服务创建成功后,页面跳转至业务服务的编辑页面。

    在创建的服务编辑页面,自动生成了一个业务流,您可根据实际需求配置节点参数。

    公开API服务流

编辑服务流

  1. 在业务服务编辑画布中,单击HTTP请求节点,设置调用该API服务时,参数Action的值(例如:GetValue)。
    其他更多参数配置请参见HTTP请求HTTP请求节点
  2. 单击脚本节点,进行节点配置。
    以空白模板中的脚本方法为例,如图所示。脚本节点更多详细的配置操作请参见Node.js脚本设备节点配置
  3. 单击HTTP返回节点,设置该API服务的返回值。
    以直接返回上一节点(payload)值(例如:hello word)为例,如图所示。更多配置内容请参见HTTP返回HTTP返回值
  4. 单击页面右上角保存,保存设置。

调试与发布

  1. 在业务服务的画布编辑页面,单击部署,部署服务。
  2. 单击调试,调试服务。
    调试服务
  3. 单击服务页面右上角发布按钮,发布该服务。
    业务需要发布到云端,才能被调用。更多详细内容请参见发布发布服务

调用示例

已发布的公开API服务,不需要鉴权和SDK,可通过HTTP接口直接调用。下文以curl命令为例,描述HTTP接口的调用方法。

  1. 在服务列表中,单击已发布的公开API服务右侧的管理按钮,选择服务调用帮助
    服务调用帮助
  2. 在服务详情页面,获取POST的API Path值(例如:http://*.com)和action的默认值(例如:GetValue)。
    服务详情
  3. 打开系统的命令窗口,输入curl命令。
    说明 命令中的action的值getTemp、和API Path的值http://*.com仅为示例,实际场景中需要替换为上一步获取的数据。
    curl -v -X POST -d "{'params':{'action':'GetValue'},'request':{'apiVer':'1.0.0'},'version':'1.0','id': 12}" http://*.com
  4. 按回车键,执行命令,获取API的返回结果。
    {"code":200,"data":"hello world","success":true,"description":"请求成功","id":"2e8fee80-***-***","message":"success"}
    返回结果