添加业务接口

前提条件

请联系系统管理员将您需要调用的第三方接口的IP或域名添加到白名单中。

操作步骤

1. 租户管理员选择“配置中心>机器人管理>流程配置”，进入流程配置页面。
2. 选择“资源管理 > 业务接口”。单击“添加”。
3. 您可以两种方式进行接口添加：自动生成消息体，手动输入消息体，下面分别介绍两种方式的操作步骤，请选择一种方式添加接口即可。
4. 自动生成消息体方式添加接口。
   1. 在“自动生成消息体”页签，设置您即将调用的接口基本信息，包括接口名称、请求方法、请求URL等信息。

      

      • 当请求方法选择TUC时，单击请求URL的输入框，可根据实际情况选择如下URL，具体接口入参出参详情请参见TUC接口。

        表1 请求方法为TUC时的请求URL

        URL	描述
        /chatbot/rest/tuc/v1/nlp/detectRegularEntity	工单流程中用到的规则实体的检测。
        /chatbot/rest/tuc/v1/nlp/identify	语种接口。
        /chatbot/rest/tuc/v1/recommendFaq	FAQ推荐接口。
        /chatbot/rest/tuc/v1/qualityInspection/qiOnline/recognize	智能助手实时质检接口。
        /chatbot/rest/tuc/v1/nlp/feedback	满意度反馈接口。
        /chatbot/rest/tuc/v1/nlp/textClassify	文本分类接口
        /chatbot/rest/tuc/v1/nlp/detectEntity	实体识别接口
        /chatbot/rest/tuc/v1/qualityInspection	智能实训接口

        须知：

        请注意，HTTP协议不是安全的网络协议，如确定使用，可能存在安全风险。推荐使用HTTPS协议。

      • 是否签名：请依据第三方接口是否做了签名校验来决定是否开启，若选择开启签名，请找第三方提供共享密钥。
        说明：

        • 请注意，不开启签名校验存在安全风险，建议选择需要签名。
        • 若开启签名，第三方提供的共享密钥定期修改后，请同步修改页面此处的共享密钥。
   2. （可选）若接口有查询参数请添加查询参数，查询参数即接口请求url后拼接?路径参数1=参数值&路径参数2=参数值。
   3. 添加接口入参。在“入参”页签，单击“添加”增加入参变量。一般该接口的入参与第三方系统接口规格中的入参保持一致。

      

      须知：

      如果您要求的入参信息包含个人数据，例如客户的身份证号等信息，此处需要将“是否加密”设置成“”，以确保数据安全。

   4. 添加接口出参。在“出参”页签，单击添加增加出参，接口的出参与第三方系统接口规格中的出参保持一致。

      

      须知：

      如果您要求的出参信息包含个人数据，例如客户的身份证号等信息，此处需要将“是否加密”设置成“”，以确保数据安全。

      参数路径的配置，如下图，若要取整个返回结果，则配置为$。若要取某个字段，则用$开头，用.来分割各个层级，这个层级一定要和返回结果结构一致，否则会解析失败或取不到想要的字段。

      图1 出参配置样例
      
   5. （可选）添加接口消息头。在“消息头”页签，添加接口所需的鉴权信息，如果没有可不配置，以第三方系统的规格为准。
      须知：

      如果您要求的接口消息头信息包含个人数据，例如客户的身份证号等信息，此处需要将“是否加密”设置成“YES”，以确保数据安全。

   6. 在“消息体”页签，将查看到自动生成的消息体，您可将生成的消息复制到调测工具中，查看是否能调用成功。
   7. 单击“确定”，完成接口添加。

5. 手动输入消息体方式添加接口。
   1. 选择“手动生成消息体”页签。设置您即将调用的接口基本信息，包括接口名称、请求方法、请求URL。具体参数解释请参见4.a。
   2. （可选）若接口有查询参数请添加查询参数，查询参数即接口请求url后拼接?路径参数1=参数值&路径参数2=参数值。
   3. 添加接口出参。在“出参”页签，单击添加增加出参，接口的出参与第三方系统接口规格中的出参保持一致。

      

      须知：

      如果您要求的出参信息包含个人数据，例如客户的身份证号等信息，此处需要将“是否加密”设置成“”，以确保数据安全。

      参数路径的配置，如下图，若要取整个返回结果，则配置为$。若要取某个字段，则用$开头，用.来分割各个层级，这个层级一定要和返回结果结构一致，否则会解析失败或取不到想要的字段。

      图2 出参配置样例
      
   4. （可选）添加接口消息头。在“消息头”页签，添加接口所需的鉴权信息，如果没有可不配置，以第三方系统的规格为准。
      须知：

      如果您要求的接口消息头信息包含个人数据，例如客户的身份证号等信息，此处需要将“是否加密”设置成“YES”，以确保数据安全。

   5. 添加消息体，进入“消息体”页签中直接输入请求消息体，例如：

      {
          "callId": "${businessReqId}",
          "provId": "202205130514",
          "busiType": "0",
          "params": {
              "tenantId": "${tenantId}"
          }
      }

      对于手动输入消息体，入参不可以手动添加，而是通过对消息体内容的解析自动生成的入参，如上面示例将会产生两个入参businessReqId、tenantId。入参businessReqId、tenantId可以是后续流程中调用该接口时需要传递的变量。

   6. 单击“确定”，完成接口添加。