codewave-openclaw-installer 1.0.0

package/skills/smart-customer-service/docs/codewave/40./346/211/251/345/261/225/344/270/216/351/233/206/346/210/220/20./351/233/206/346/210/220/345/274/200/345/217/221/346/226/271/345/274/217/30./345/272/224/347/224/250API/351/233/206/346/210/220/20./347/254/254/344/270/211/346/226/271API/345/257/274/345/205/245/346/241/210/344/276/213.md

@@ -0,0 +1,251 @@
+# 第三方API导入案例
+
+本章节示范在平台中使用第三方API，开发者可参考本案例了解调用外部接口的操作步骤，案例中提供的接口可直接调用。
+
+- 案例一：调用get接口，添加query参数，查询手机号归属地信息。
+- 案例二：调用post接口，添加json格式的body参数，查询天气信息。
+
+## 案例一
+
+### 场景描述
+
+将查询手机号码归属地的API导入到Codewave平台中，并在CodeWave应用中调用该API。
+
+<img src="../assets/disanfangapidaoruanli_0424_1.png" style="width:800px;border: 1px solid #ccc;" />
+
+### 案例接口说明
+
+接口作用：传入手机号，返回手机号归属地信息。
+
+接口请求地址：`https://qqlykm.cn/api/free/phone/get`
+
+返回格式：json/text
+
+请求方式：get
+
+query参数说明：
+
+| 名称    | 必填 | 类型     | 示例值         | 说明       |
+| :---- | :- | :----- | :---------- | :------- |
+| phone | 是  | string | 13555599999 | 要查询的手机号码 |
+
+返回参数说明：
+
+| 名称              | 类型      | 说明                      |
+| :-------------- | :------ | :---------------------- |
+| success         | boolean | 是否查询成功                  |
+| msg             | string  | 请求结果数据集                 |
+| data            | object  | 请求结果数据集                 |
+| data.province   | string  | 归属地省份                   |
+| data.city       | string  | 归属地城市                   |
+| data.area_code | string  | 归属地区号                   |
+| data.post_code | string  | 归属地邮政编码                 |
+| data.isp        | string  | 手机号运营商                  |
+| data.msg        | string  | 错误信息，仅当success为false时有值 |
+
+返回示例（success为true时）：
+
+```json
+{
+"success": true,
+"data": {
+    "province": "中国黑龙江",
+    "city": "佳木斯",
+    "area_code": "0454",
+    "post_code": "154000",
+    "isp": "中国移动"
+    }
+}
+```
+
+### 操作步骤
+
+#### 1. 添加API分组
+
+创建API分组，协议需要与上文接口一致，调用域名无需输入接口的完整URL，输入前置URL即可：[https://qqlykm.cn](https://qqlykm.cn/api/free/phone/get)
+
+<img src="../assets/disanfangapidaoruanli_0424_2.png" style="border: 1px solid #ccc;" />
+
+#### 2. 快捷创建API
+
+1. 在分组详情-API管理下点击“快捷创建API”。
+
+2. 在弹窗中填入必要的接口名称、接口标识、请求路径。请求标识选择POST，请求路径输入`/api/free/phone/get`
+
+3. 将响应体JSON填入到ResponseBody中。
+
+    <img src="../assets/disanfangapidaoruanli_0424_3.png" style="border: 1px solid #ccc;" />
+
+4. 按照接口文档，添加Query参数`phone`。点击创建按钮即可。
+
+    <img src="../assets/disanfangapidaoruanli_0424_4.png" style="border: 1px solid #ccc;" />
+
+#### 3. API调试（可选）
+
+进入该API详细信息页面，点击【调试】按钮，在弹窗中为query参数phone填充测试的手机号，点击【调试】按钮，可在弹窗中预览接口调用结果。
+
+<img src="../assets/disanfangapidaoruanli_0424_5.png" style="border: 1px solid #ccc;" />
+
+#### 4.使用API
+
+1. 进入CodeWave应用，在服务端逻辑中使用【调用接口】组件，找到创建的API分组并展开，选择获取手机号归属地的接口，赋值给变量用于接收接口调用结果。
+
+    <img src="../assets/disanfangapidaoruanli_0424_6.png" style="border: 1px solid #ccc;" />
+
+2. 创建页面，调用创建好的服务端逻辑，展示查询结果。
+
+    <img src="../assets/disanfangapidaoruanli_0424_7.png" style="border: 1px solid #ccc;" />
+
+    <img src="../assets/disanfangapidaoruanli_0424_8.png" style="border: 1px solid #ccc;" />
+
+#### 5.效果演示
+
+<img src="../assets/disanfangapidaoruanli_0424_9.gif" style="width:800px;border: 1px solid #ccc;" />
+
+## 案例二
+
+### 场景描述
+
+跟随本案例操作，将查询天气的接口导入到平台中，并在应用中调用。
+
+<img src="../assets/disanfangapidaoruanli_202412041204_1.png" class="imgStyle" style="" />
+
+### 案例接口说明
+
+接口作用：传入城市名称，返回当天天气数据。
+
+请求方式：POST
+
+请求地址：<https://dev-openapi-jystudy2.app.codewave.163.com/rest/queryWeather>
+
+请求体参数（JSON）：
+
+| 名称   | 必填 | 类型     | 示例值 | 说明         |
+| :--- | :- | :----- | :-- | :--------- |
+| city | 是  | string | 杭州  | 要查询天气的城市名称 |
+
+示例：
+
+```json
+{
+    "city": "杭州"
+}
+```
+
+响应体参数：
+
+| 名称                            | 类型      | 示例值                 | 说明              |
+| :---------------------------- | :------ | :------------------ | :-------------- |
+| success                       | boolean | true                | 是否查询成功          |
+| city                          | String  | 杭州                  | 查询天气的城市名称       |
+| update\_time                  | String  | 2024-12-02 13:45:03 | 响应时间            |
+| msg                           | String  | 查询成功                | 接口提示信息          |
+| data.current\_weather         | String  | 晴                   | 当前天气状况。         |
+| data.current\_temperature     | Integer | 9                   | 当前温度（单位：摄氏度）。   |
+| data.today\_weather           | String  | 晴                   | 今日天气状况。         |
+| data.today\_high\_temperature | Integer | 20                  | 今日最高温度（单位：摄氏度）。 |
+| data.today\_low\_temperature  | Integer | 8                   | 今日最低温度（单位：摄氏度）。 |
+| data.aqi                      | Integer | 58                  | 空气质量指数。         |
+| data.quality\_level           | String  | 良                   | 空气质量级别。         |
+| data.wind\_direction          | String  | 南风                  | 风向。             |
+| data.wind\_level              | Integer | 2                   | 风力等级。           |
+
+示例：
+
+```json
+{
+    "success": true,
+    "city": "杭州",
+    "data": {
+        "current_weather": "晴",
+        "current_temperature": 9,
+        "today_weather": "晴",
+        "today_high_temperature": 20,
+        "today_low_temperature": 8,
+        "aqi": 58,
+        "quality_level": "良",
+        "wind_direction": "南风",
+        "wind_level": 2
+    },
+    "update_time": "2024-12-02 13:45:03",
+    "msg": "查询成功"
+}
+```
+
+### 操作步骤
+
+#### 1. 添加API分组
+
+进入集成中心>应用API管理，点击按钮创建API分组。
+
+分组名称和分组标识自定义即可。调用域名输入仅包含域名的部分，无需包含完整接口路径。
+
+<img src="../assets/disanfangapidaoruanli_202412041204_2.png" class="imgStyle" style="" />
+
+#### 2. 创建API
+
+创建API分组后进入到分组中，点击“创建API”按钮。
+
+接口名称和接口标识自定义即可。请求标识选择POST，请求路径输入域名以外的路径即可。
+
+<img src="../assets/disanfangapidaoruanli_202412041204_3.png" class="imgStyle" style="" />
+
+#### 3.添加请求信息
+
+创建API之后，进入到该API中配置“请求信息”。由于请求体的JSON中只有一个city字段，在requestBody中添加一个对应的字段即可：
+
+<img src="../assets/disanfangapidaoruanli_202412041204_4.png" class="imgStyle" style="" />
+
+#### 4.添加响应信息
+
+由于响应信息的JSON中有复杂类型，此类复杂类型需要先为其创建“数据模型”，再将对应字段的数据类型设置为创建的数据模型，类似于IDE中的数据结构。
+
+<img src="../assets/disanfangapidaoruanli_202412041204_5.png" class="imgStyle" style="" />
+
+在该API分组下选择API管理>数据模型>创建数据模型。模型名称可自行定义。
+
+<img src="../assets/disanfangapidaoruanli_202412041204_6.png" class="imgStyle" style="" />
+
+创建了数据模型后进入到该模型中，添加对应的字段并保存。
+
+<img src="../assets/disanfangapidaoruanli_202412041204_7.png" class="imgStyle" style="" />
+
+回到API中，修改响应信息，按照响应体JSON字段添加对应的响RequestBody字段，其中复杂类型data字段的数据类型设置为上面创建的数据模型。
+
+<img src="../assets/disanfangapidaoruanli_202412041204_8.png" class="imgStyle" style="" />
+
+<img src="../assets/disanfangapidaoruanli_202412041204_9.png" class="imgStyle" style="" />
+
+注意，当需要将接口参数中的日期、时间、日期时间设置为平台中的对应类型时，必须使用指定格式的字符串才能成功实现类型转换，例如，日期时间类型需要为2024-06-19T17:13:50.495Z这种格式，所以本案例中的update\_time字段建议使用String文本类型，否则会出现类型转换错误。
+
+#### 5.API调试（可选）
+
+可在API的详细信息下点击调试按钮，在Body输入框中输入JSON后测试接口响应结果。
+
+<img src="../assets/disanfangapidaoruanli_202412041204_10.png" class="imgStyle" style="" />
+
+#### 6.调用API
+
+在开发应用时，在逻辑中使用调用接口组件，选择上文创建的接口。
+
+接收接口返回结果的变量无需设置数据类型，类型会自动推断。
+
+<img src="../assets/disanfangapidaoruanli_202412041204_11.png" class="imgStyle" style="" />
+
+接口的Body参数需要设置为合适的数据类型，可以使用变量也可以使用新建组件，所需数据类型的名称为：`接口标识+Body`。如下图所示，接口的标识为`QueryWeather`，则接口Body数据类型的名称为`QueryWeatherBody`。
+
+<img src="../assets/disanfangapidaoruanli_202412041204_12.png" class="imgStyle" style="" />
+
+#### 7.效果演示
+
+在页面中调用接口，效果图如下。
+
+<img src="../assets/disanfangapidaoruanli_202412041204_13.gif" class="imgStyle" style="" />
+
+
+<div style="text-align: right;font-size: 14px;">
+    <span style="color: rgb(78, 110, 142);">创建人：</span>
+    <span style="color: rgb(118, 118, 118);">老王</span>
+    <span style="color: rgb(78, 110, 142);margin: 0 0 0 40px;">更新时间：</span>
+    <span style="color: rgb(118, 118, 118);">2024年04月24日</span>
+</div>

package/skills/smart-customer-service/docs/codewave/40./346/211/251/345/261/225/344/270/216/351/233/206/346/210/220/20./351/233/206/346/210/220/345/274/200/345/217/221/346/226/271/345/274/217/30./345/272/224/347/224/250API/351/233/206/346/210/220/25.API/344/275/277/347/224/250/345/270/270/350/247/201/351/227/256/351/242/230.md

@@ -0,0 +1,315 @@
+# API使用常见问题
+
+| 常见问题列表              |
+| ----------------------------------------------- |
+| [如何查看应用开放接口的外部调用地址](#如何查看应用开放接口的外部调用地址)              |
+| [如何调用请求参数为日期/时间类型的CodeWave应用接口](#如何调用请求参数为日期-时间类型的CodeWave应用接口) |
+| [如何调用x-www-form-urlencoded编码的接口](#如何调用x-www-form-urlencoded编码的接口)         |
+| [调用接口时如何添加鉴权参数](#调用接口时如何添加鉴权参数)                          |
+| [如何调用动态的接口地址](#如何调用动态的接口地址)                          |
+| [接口调用失败如何解决](#接口调用失败如何解决)                          |
+| [接口输入参数如何设置为非必填](#接口输入参数如何设置为非必填)                          |
+| [如何调用本地接口](#如何调用本地接口)                          |
+| [如何设置接口超时时间](#如何设置接口超时时间)                          |
+| [如何调用流式接口](#如何调用流式接口)                          |
+| [如何接收格式为xml的接口响应内容](#如何接收格式为xml的接口响应内容)                          |
+| [修改外部接口后在应用中如何更新](#修改外部接口后在应用中如何更新)                          |
+| [逻辑开放为接口后如何观察调用情况](#逻辑开放为接口后如何观察调用情况)                          |
+| [如何调用带有中文的接口路径](#如何调用带有中文的接口路径)                          |
+| [接口的请求/响应字段有多种类型](#接口的请求/响应字段有多种类型)                          |
+
+## 如何查看应用开放接口的外部调用地址
+
+将CodeWave应用中的逻辑开放为接口后，其外部调用地址为：制品应用域名+接口请求路径。
+
+接口的请求路径可在将逻辑开放为接口时编辑，路径默认为：`/rest/接口名称`
+
+<img src="../assets/APIshiyongchangjianwenti_202406281017_1.png" class="imgStyle" style="" />
+
+也可在**集成中心-应用API管理**中找到对应的CodeWave应用，查看其开放的接口。
+
+以下图为例，制品应用的域名为`dev-a-main.app.codewave.163.com`，某接口的路径为`/rest/getAllBook`，则接口的实际调用地址为`dev-a-main.app.codewave.163.com/rest/getAllBook`
+
+<img src="../assets/APIshiyongchangjianwenti_202406281017_2.png" class="imgStyle" style="" />
+
+<img src="../assets/APIshiyongchangjianwenti_202406281017_3.png" class="imgStyle" style="" />
+
+## 如何调用请求参数为日期/时间类型的CodeWave应用接口
+
+将输入参数为日期/时间类型的逻辑开放为接口时，调用接口所填的日期/时间需要使用 ISO8601标准格式，示例如下：
+
+- 日期：2024-06-19
+- 时间：2024-06-19T17:13:50.495Z
+- 日期时间：11:13:50
+
+如下图所示，逻辑的输入参数分别使用Date、Time、DateTime，开放为接口后，调用时请求参数使用指定格式的字符串即可。
+
+<img src="../assets/APIshiyongchangjianwenti_202406281017_4.png" class="imgStyle" style="" />
+
+<img src="../assets/APIshiyongchangjianwenti_202406281017_5.png" class="imgStyle" style="" />
+
+## 如何调用x-www-form-urlencoded编码的接口
+
+当接口参数类型为**x-www-form-urlencoded**时，需要进入接口详情页，修改请求信息：
+
+编辑Request Header，添加一个请求头，名称选择`Content-Type`，默认值填入`application/x-www-form-urlencoded`。完成编辑后单击保存按钮。其他请求信息无需做特殊处理。
+
+<img src="../assets/APIshiyongchangjianwenti_202406281017_6.png" class="imgStyle" style="" />
+
+## 调用接口时如何添加鉴权参数
+
+在调用第三方接口时可能需要传递鉴权参数，例如，需要在请求头中添加Authorization，可通过多种方式实现：
+
+- 方式一：在定义接口时添加请求信息字段。
+
+  如下图所示，在接口的请求信息中添加Request Header，在逻辑中调用该接口时可传入实际的参数值。
+
+  <img src="../assets/apishiyongchangjianwenti_202411111801_1.png" class="imgStyle" style="" />
+
+  <img src="../assets/apishiyongchangjianwenti_202411111801_2.png" class="imgStyle" style="width:500px;" />
+
+- 方式二：使用平台提供的接口鉴权功能。
+
+  在CodeWave应用中可以添加鉴权方式，使用调用接口组件时可以选择鉴权方式。如下图所示，创建了一个外部接口的鉴权方式，使用put函数注入了请求头信息，调用接口时设置鉴权方式即可。详细的介绍请参考文档[如何自定义一种鉴权方式](../30.应用API集成/30.接口鉴权/30.如何自定义一种鉴权方式.md)。
+
+  注意，只有在服务端逻辑中调用接口时才可以设置鉴权方式，在前端调用接口无法设置，当接口需要鉴权时建议在服务端调用而非前端调用，避免从页面泄漏敏感参数。
+
+  <img src="../assets/ruhezidingyiyizhongjianquanfangshi_0611_2.png" style="border: 1px solid #ccc;" />
+  
+  <img src="../assets/ruhezidingyiyizhongjianquanfangshi_0611_1.png" style="width:600px;border: 1px solid #ccc;" />
+
+## 如何调用动态的接口地址
+
+在开发时可能希望调用的接口地址为动态传参，可选择以下实现方式：
+
+- **场景一：接口的域名为固定，请求路径为动态**：
+
+    创建API时可在请求路径中加入`{xxx}`，代表需要动态传入的接口路径，例如接口路径为`/api/{username}/{phone}`，则调用该接口时可传入实际的username和phone参数。
+
+    <img src="../assets/APIshiyongchangjianwenti_202406281017_7.png" class="imgStyle" style="width: 500px;" />
+
+    <img src="../assets/APIshiyongchangjianwenti_202406281017_8.png" class="imgStyle" style="width: 500px;" />
+
+
+- **场景二：接口的域名和请求路径都为动态**：
+
+    可通过HttpClient依赖库来实现，该依赖库的下载与详细使用说明请前往[资产市场>依赖库](https://community.codewave.163.com/CommunityParent/CodeWaveMarket?navia=&currentType=%E6%90%9C%E4%BE%9D%E8%B5%96)搜索“httpClient”。
+
+## 接口调用失败如何解决
+
+在平台的API调试或发布的应用中无法成功调通第三方接口时，请检查以下问题：
+
+1. 确认该接口确实是可用的，例如可以使用Postman、Apifox等工具在本机进行接口测试。
+2. 确认该接口是否存在调用频率限制，例如已经达到每日调用上限或者每分钟调用次数限制。
+3. 检查在Codewave平台中配置的接口域名和请求路径是否正确。
+4. 检查接口来源方是否需要设置白名单，只有在白名单内的IP或域名才能调用成功。
+5. 检查接口的请求参数是否正确，例如缺少鉴权参数可能导致调用失败。
+
+## 接口输入参数如何设置为非必填
+
+应用中的逻辑开放为接口时，希望将接口的输入参数设置为非必填。如下图所示，三个参数都默认为必填，希望将page和size修改为非必填。
+
+<img src="../assets/APIshiyongchangjianwenti_20240724_1.png" class="imgStyle" style="width: 500px;" />
+
+解决方法：为对应的逻辑输入参数设置默认值即可。
+
+如图所示，为page和size设置默认值后，开放为接口时便可看到对应的参数为非必填。
+
+<img src="../assets/APIshiyongchangjianwenti_20240724_2.png" class="imgStyle" style="" />
+
+<img src="../assets/APIshiyongchangjianwenti_20240724_3.png" class="imgStyle" style="width: 500px;" />
+
+## 如何调用本地接口
+
+希望在CodeWave应用中调用本机运行的web接口时，可参考以下两种方式实现：
+
+- 方式一：将本地的接口部署到公网，使其可以用域名或公网IP地址进行调用，在Codewave平台的API分组中配置对应的域名或IP即可。
+- 方式二：将平台中API分组的域名修改为localhost，例如`http://localhost:8081`，将应用[导出源码](../../../30.应用生命周期管理/100.应用导出与部署/00.应用导出与部署介绍.md)并在本机部署后即可调用本地的接口，此方法无法在平台的开发环境或生产环境中调用本地接口。
+
+    如果应用中调用的接口是使用的公网域名或IP，也可以在导出源码后再修改接口域名，如下图所示，导出源码后可以在Java项目的配置文件中找到API分组信息，可以修改域名为localhost。
+
+    ![](../assets/APIshiyongchangjianwenti_20240815_1.png)
+
+## 如何设置接口超时时间
+
+配置制品应用的接口超时时间，需要进入**应用配置>系统参数配置**，点击**添加系统参数**，选择**接口请求超时时间**并添加，然后可以修改开发环境或生产环境的超时时间（秒）。
+
+该配置的生效范围包括页面调用服务端接口和服务端调用第三方接口，也包括连接器中调用的接口，但不包括API调试。
+
+<img src="../assets/APIshiyongchangjianwenti_20240903_1.png" class="imgStyle" style="width: 500px;" />
+<br>
+<img src="../assets/APIshiyongchangjianwenti_20240903_2.png" class="imgStyle" style="width: 600px;" />
+<br>
+<img src="../assets/APIshiyongchangjianwenti_20240903_3.png" class="imgStyle" style="width: 600px;" />
+<br>
+<img src="../assets/APIshiyongchangjianwenti_20240903_4.png" class="imgStyle" style="width: 600px;" />
+
+## 如何调用流式接口
+
+流式接口是指实现了SSE协议、响应结果以流式的方式返回给客户端的接口，例如，使用AI问答的产品时会发现AI的回答是逐字输出的，呈现打字机效果，而不是等全部回答完才返回整体结果。
+
+Codewave 3.10及以上版本支持使用连接器调用流式接口，开发者可以在制品应用中实现AI问答的打字机输出效果，详细的文档介绍请参考[连接器SSE协议介绍](../20.连接器集成/30.自定义连接器/18.连接器SSE协议介绍.md)，调用AI流式接口的案例与demo下载请参考：[使用连接器SSE实现AI对话流式输出](../20.连接器集成/30.自定义连接器/21.使用连接器SSE实现AI对话流式输出.md)
+
+<img src="../assets/lianjieqiSSExieyijieshao_202409031014_1.gif" class="imgStyle" style="max-width: 800px;" />
+
+## 如何接收格式为xml的接口响应内容
+
+当接口的响应格式为xml时，可选择当做字符串承接或者当做对象承接（转换成数据结构）。
+
+**方式一：作为字符串承接**
+
+在接口的响应信息中添加一个ResponseBody字段，名称为“\_blank”，数据类型为String。
+
+<img src="../assets/apishiyongchangjianwenti_202411071919_1.png" class="imgStyle" style="" />
+
+调用该接口后，可获取xml字符串内容。
+
+<img src="../assets/apishiyongchangjianwenti_202411071919_2.png" class="imgStyle" style="" />
+
+**方式二：作为作为对象承接**
+
+在ResponseBody中设置xml对应的数据结构，在服务端逻辑中调用接口时，会将xml自动转换成对应的数据结构。
+
+示例：
+
+某接口的响应的xml内容如下：
+```xml
+<?xml version="1.0" encoding="UTF-8" ?>
+<root>
+    <id>123</id>
+    <project>
+        <name>任务项1</name>
+        <description>任务项1的描述</description>
+    </project>
+</root>
+```
+可复制xml示例内容，使用xml转JSON工具获取对应的json内容：[Xml与Json在线转换工具](https://tool.getman.cn/json2xml/)
+```json
+{
+  "root": {
+    "id": "123",
+    "project": 
+      {
+        "name": "任务项1",
+        "description": "任务项1的描述"
+      }
+    }
+}
+```
+由于该JSON中存在复杂结构（如root、project字段），需要先创建复杂结构对应的数据模型。
+
+<img src="../assets/apishiyongchangjianwenti_202411071919_3.png" class="imgStyle" style="" />
+
+<img src="../assets/apishiyongchangjianwenti_202411071919_4.png" class="imgStyle" style="" />
+
+<img src="../assets/apishiyongchangjianwenti_202411071919_5.png" class="imgStyle" style="" />
+
+创建好数据模型后，在响应信息中添加ResponseBody字段即可。
+
+<img src="../assets/apishiyongchangjianwenti_202411071919_6.png" class="imgStyle" style="" />
+
+在制品应用中调用接口时会自动将获取到的xml转换成对应的数据结构。
+
+注意：必须在服务端逻辑中调用该接口才能成功将xml解析为数据结构，在前端直接调用接口无法成功解析。
+
+<img src="../assets/apishiyongchangjianwenti_202411071919_7.png" class="imgStyle" style="width: 500px;" />
+
+## 修改外部接口后在应用中如何更新
+
+当应用中调用了第三方接口时，如果在API分组中对接口进行了修改，直接重新发布应用并不会使应用中调用的接口发生改变，需要在应用中同步更新后的接口。
+
+例如，在应用中已经调用了查询天气的接口，后续为该接口额外添加了一个响应参数，但是应用中调用时发现找不到该响应参数字段，这是由于应用中的接口数据依然是旧版本的，没有同步新的接口。
+
+<img src="../assets/APIshiyongchangjianwenti_202412112211_1.png" class="imgStyle" style="" />
+
+<img src="../assets/APIshiyongchangjianwenti_202412112211_2.png" class="imgStyle" style="" />
+
+解决方式：
+
+修改接口时，如果该接口有被调用过，则会出现弹窗进行二次确认。
+
+<img src="../assets/APIshiyongchangjianwenti_202412112211_3.png" class="imgStyle" style="" />
+
+接口更新之后，调用过该接口的应用的问题栏中会出现提示：“应用API管理模块的接口有更新“。可双击该提示，在弹窗中更新应用中引用过的接口。
+
+<img src="../assets/APIshiyongchangjianwenti_202412112211_4.png" class="imgStyle" style="" />
+
+也可以手动在应用中定位到相关接口，接口上提示“有更新”则代表该接口发生了变化，点击“更新接口”按钮即可。
+
+<img src="../assets/APIshiyongchangjianwenti_202412112211_5.png" class="imgStyle" style="" />
+
+
+## 逻辑开放为接口后如何观察调用情况
+
+将服务端逻辑开放为接口后，可能需要观察该接口的调用情况。例如，希望知道开放的接口被调用时收到的参数是什么，可通过打印日志或者使用调试功能来实现。
+
+- **方式一：打印日志**
+
+    在开放为接口的服务端逻辑中可以使用打印日志组件，输出关键信息，例如Query或Body参数对应的输入参数、请求头中的特定字段。
+
+    <img src="../../../..//assets/APIshiyongchangjianwenti_202501141615_1.png" class="imgStyle" style="" />
+
+
+- **方式二：使用调试功能**
+
+    使用断点调试功能，在逻辑中设置断点，并发布调试。调试功能的具体使用方式请参考文档：[逻辑调试](../../../20.应用开发/15.逻辑功能实现/45.逻辑编辑/80.逻辑调试.md)。
+
+    当调用开放的接口后，IDE中会停在断点处，可以观察变量数据，并逐步运行逻辑。
+
+    <img src="../../../..//assets/APIshiyongchangjianwenti_202501141615_2.png" class="imgStyle" style="" />
+
+注意，在开放接口的鉴权逻辑中也可以进行断点调试或打印日志。
+
+<img src="../../../..//assets/APIshiyongchangjianwenti_202501141615_3.png" class="imgStyle" style="" />
+
+## 如何调用带有中文的接口路径
+
+在定义接口域名和路径时无法输入中文，可以通过path参数来实现中文接口路径。
+
+操作示例：
+
+1. 接口的请求路径为`http://a.com/api/用户`，在创建API时，“请求路径”中无法输入中文。
+
+    <img src="../assets/APIshiyongchangjianwenti_202502131416_1.png" class="imgStyle" style="" />
+
+2. 可以将路径中的中文部分作为path参数，使用大括号的形式表示需要动态传入的路径。
+
+    <img src="../assets/APIshiyongchangjianwenti_202502131416_2.png" class="imgStyle" style="width:400px;" />
+
+3. 在应用中调用该接口时便可以传入实际的路径参数，支持传入中文。
+
+    <img src="../assets/APIshiyongchangjianwenti_202502131416_3.png" class="imgStyle" style="width:600px;" />
+
+
+## 接口的请求/响应字段有多种类型
+
+在调用API时，第三方API的请求体或响应体的同一个字段可能会出现多种类型，如字符串、对象、数组等。
+例如，以下是某接口的响应体，其中的info字段在某些情况下为字符串，另一些情况下为复杂对象结构。
+
+```
+{
+    "id": "123",
+    "info": "这是字符串类型"
+}
+```
+
+```
+{
+    "id": "123",
+    "info": {
+        "name": "张三"
+        "age": 18
+    }
+}
+```
+
+对于此类接口，在定义API时需要为请求体或响应体的字段使用联合类型，即同一个字段关联多种数据类型。
+
+![](../assets/yingyongAPIguanligongneng_202511251110_1.png)
+
+<div style="text-align: right;font-size: 14px;">
+    <span style="color: rgb(78, 110, 142);">创建人：</span>
+    <span style="color: rgb(118, 118, 118);">老王</span>
+    <span style="color: rgb(78, 110, 142);margin: 0 0 0 40px;">更新时间：</span>
+    <span style="color: rgb(118, 118, 118);">2025年11月25日</span>
+</div>

package/skills/smart-customer-service/docs/codewave/40./346/211/251/345/261/225/344/270/216/351/233/206/346/210/220/20./351/233/206/346/210/220/345/274/200/345/217/221/346/226/271/345/274/217/30./345/272/224/347/224/250API/351/233/206/346/210/220/28./345/272/224/347/224/250API/345/257/271/346/216/245/345/276/256/346/234/215/345/212/241/346/236/266/346/236/204.md

@@ -0,0 +1,63 @@
+# 应用API对接微服务架构
+
+## 功能介绍
+
+CodeWave平台3.9版本开始支持制品应用对接已有的微服务架构，实现服务发现与服务注册，在CodeWave应用中可调用微服务接口，应用开放的接口也可以自动上报到注册中心，方便其他服务调用。
+
+## 操作示例
+
+### 创建第三方注册中心
+
+调用微服务接口之前需要在应用API管理中录入接口数据。
+
+创建API分组时，接口来源选择“第三方注册中心”，需要输入调用的微服务名，其他配置与第三方应用API配置相同。
+
+<img src="../assets/yingyongAPIduijieweifuwujiagou_202407032053_1.png" class="imgStyle" style="" />
+
+创建API分组后进入该分组，创建所需的API。
+
+<img src="../assets/yingyongAPIduijieweifuwujiagou_202407032053_2.png" class="imgStyle" style="" />
+
+### 添加微服务连接器
+
+在CodeWave应用中实现调用微服务接口或服务注册，需要引入微服务连接器。
+
+在应用IDE中选择集成-导入连接器。
+
+<img src="../assets/yingyongAPIduijieweifuwujiagou_202407032053_3.png" class="imgStyle" style="" />
+
+从资产中心或资产市场导入需要的微服务连接器，以nacos微服务连接器为例。
+
+<img src="../assets/yingyongAPIduijieweifuwujiagou_202407032053_4.png" class="imgStyle" style="" />
+
+成功导入微服务连接器后，在可用连接器列表中点击添加所需的连接器，在弹窗中输入配置信息：
+
+- serverAddr：注册中心地址
+- nameSpace：命名空间
+- username：用户名
+- password：密码
+
+<img src="../assets/yingyongAPIduijieweifuwujiagou_202407032053_5.png" class="imgStyle" style="" />
+
+### 调用微服务接口
+
+配置了微服务接口和连接器后，在逻辑中使用调用接口组件，“接口来源”选择创建的微服务连接器，并选择要调用的接口即可。
+
+<img src="../assets/yingyongAPIduijieweifuwujiagou_202407032053_6.png" class="imgStyle" style="" />
+
+<img src="../assets/yingyongAPIduijieweifuwujiagou_202407032053_7.png" class="imgStyle" style="" />
+
+### CodeWave应用接口上报到注册中心
+
+配置了微服务连接器后，将逻辑开放为接口时，“接口上报”选项中可选择创建的微服务连接器，应用启动时会将该接口上报到注册中心。
+
+<img src="../assets/yingyongAPIduijieweifuwujiagou_202407032053_8.png" class="imgStyle" style="" />
+
+<img src="../assets/yingyongAPIduijieweifuwujiagou_202407032053_9.png" class="imgStyle" style="" />
+
+<div style="text-align: right;font-size: 14px;">
+    <span style="color: rgb(78, 110, 142);">创建人：</span>
+    <span style="color: rgb(118, 118, 118);">老王</span>
+    <span style="color: rgb(78, 110, 142);margin: 0 0 0 40px;">更新时间：</span>
+    <span style="color: rgb(118, 118, 118);">2024年7月3日</span>
+</div>

package/skills/smart-customer-service/docs/codewave/40./346/211/251/345/261/225/344/270/216/351/233/206/346/210/220/20./351/233/206/346/210/220/345/274/200/345/217/221/346/226/271/345/274/217/30./345/272/224/347/224/250API/351/233/206/346/210/220/30./346/216/245/345/217/243/351/211/264/346/235/203/10./346/216/245/345/217/243/351/211/264/346/235/203/347/256/200/344/273/213.md

@@ -0,0 +1,25 @@
+# 接口鉴权
+
+## **1.什么是接口鉴权**
+
+接口鉴权是一种用于验证和授权访问接口的机制。它确保只有经过身份验证和授权的用户或应用程序能够使用特定的接口。
+
+## **2. CodeWave的接口鉴权支持的功能点**
+
+- 支持对服务端逻辑开放为接口设置鉴权，鉴权参数和鉴权逻辑可自定义
+- 支持调用外部接口时设置鉴权，鉴权参数和鉴权逻辑可自定义
+- 默认提供了aksk鉴权方式模板，开发者可基于该鉴权方式修改为需要的鉴权方式
+
+## **3. CodeWave的开放接口与外部接口的定义**
+
+- 开放接口：是指将CodeWave平台的逻辑开放为接口，便于第三方系统调用
+- 外部接口：是指在CodeWave平台调用外部的第三方接口
+
+## **4. 接口鉴权的使用场景**
+
+- 服务端逻辑开放为接口时，对接口有安全性要求，不希望没有权限的第三方服务调用本接口，需要设置接口鉴权。
+- 调用外部接口时，若接口有鉴权，CodeWave应用需要按照接口要求设置鉴权方式。
+
+## **5. 接口鉴权的使用限制**
+
+出于安全考虑，对于有鉴权的接口仅支持在服务端逻辑中使用。若前端逻辑需要调用有鉴权的接口，请先通过服务端逻辑调用鉴权接口，再通过前端逻辑调用服务端逻辑完成接口调用。