[第九章]接口域名使用配置教程

接口域名配置使用教程

一、什么是接口域名？

接口域名是专门用于访问 API 接口的域名，与网站主站域名分开使用。

例如：

• 网站主站：https://www.baidu.com
• 接口域名：https://api.baidu.com

用户调用接口时，可以使用接口域名访问：

https://api.baidu.com/api/接口路径

接口域名本质上仍然指向当前 API 系统，只是为接口访问提供了独立的入口。

二、接口域名功能是干什么的？

配置接口域名后，可以实现以下功能：

• 将 API 请求地址与网站主站地址分开。
• 支持配置多个接口域名。
• 适合正式环境、测试环境和多域名分发场景。

三、进入接口域名配置页面

进入后台：

系统管理 → 网站信息配置 → 接口域名配置

打开后可以看到当前已经添加的接口域名列表。

列表中通常会显示：

• 接口域名
• 协议
• 启用状态
• 是否允许访问站点
• 配置
• 删除

四、添加接口域名

点击右上角“添加”按钮，填写以下内容。

1. 选择协议

根据域名实际访问方式选择：

• http
• https

例如：

https://api.baidu.com

或者：

https://api2.baidu.com

协议必须与实际网站访问协议一致。如果网站配置的是 HTTPS，却填写成 HTTP，可能导致请求跳转、证书或跨域问题。

2. 填写域名

填写域名或 IP 地址，不需要重复填写路径。

正确示例：

api.example.com

127.0.0.1

不建议填写：

api.baidu.com/api

https://api.baidu.com/api/yiyan

接口域名只填写域名和ip，具体接口路径由系统自动拼接。

3. 设置启用状态

开启后，该域名才会作为有效接口域名使用。

关闭后：

• 系统不会再把它作为公开接口地址。
• 前端不会继续展示该域名。
• 如果“仅使用接口域名”已开启，网站域名将无法正常作为接口入口使用。

4. 保存配置

确认协议、域名和端口填写无误后，点击保存。

如果域名配置正确，列表中会显示该域名，并可以继续进行单独配置。

五、单独配置接口域名

在接口域名列表中，点击对应域名右侧的“配置”按钮，可以设置该域名是否允许访问网站页面。

允许访问站点

开启后，通过该接口域名访问网站页面时可以正常打开。

例如访问：

https://api.baidu.com/

系统会允许进入站点页面。

不允许访问站点

关闭后，该域名只用于 API 请求。

通过该域名访问网站首页、用户中心或其他非 API 页面时将无法打开。

API 请求路径仍然可以正常使用，例如：

https://api.baidu.com/api/yiyan

这个设置适合只想让域名提供接口服务、不希望用户通过接口域名进入网站的情况。

六、“仅使用接口域名”功能

“仅使用接口域名”是网站信息配置中的总开关，不属于某一个单独域名的配置。

例如：

https://www.baidu.com/api/yiyan

开启后会改为：

https://api.baidu.com/api/yiyan

七、接口域名配置示例

假设网站主站为：

https://www.baidu.com

配置两个接口域名：

https://api.baidu.com
https://api2.baidu.com

并开启“仅使用接口域名”。

此时接口文档可以展示：

https://api.baidu.com/api/yiyan
https://api2.baidu.com/api/yiyan

用户可以根据需要选择其中一个接口地址进行请求。

八、HTTPS 配置说明

接口域名使用 HTTPS 时，需要先完成以下配置：

1. 将域名 DNS 解析到当前服务器。
2. 在服务器面板中为该域名创建站点或绑定域名。
3. 为该域名配置 SSL 证书。
4. 确认 HTTPS 可以正常访问。
5. 再在系统中选择 HTTPS 并添加接口域名。

系统后台不需要填写证书内容。证书应在宝塔或 Web 服务器中配置。

如果服务器只配置了一个站点证书，而多个域名没有对应证书，直接使用 HTTPS 可能会出现证书不匹配。此时应先处理服务器层面的域名和证书配置。

十、删除接口域名后的影响

删除接口域名后，该域名将不再属于系统当前启用的接口域名。

如果“仅使用接口域名”已经开启，删除后：

• 前端不会继续显示该域名。
• 使用该域名请求接口可能无法通过接口域名校验。
• 建议先关闭“仅使用接口域名”，再删除正在使用的接口域名。

如果系统还需要继续提供接口服务，应至少保留一个已经解析并可正常访问的接口域名。