主屏幕 > 网页管理工具 > 与外部应用程序关联 > 使用OpenAPI

## 使用OpenAPI

### 设置流程

如需使用应用程序通过OpenAPI与本机通信，请配置本机的OpenAPI设置。

如果已注册本机证书，当使用本机充当服务器时可以使用SSL加密本机与客户端之间的通信。

通过使用本机的简单服务协议(SSDP)功能，可以与OpenAPI连接应用程序顺畅关联。

如需通过OpenAPI执行关联，请按照以下步骤配置设置。

1
网络设置
2
配置基本OpenAPI设置
3
请根据您的环境配置设置

- 使用代理服务器

- 使用SSL通信

### 配置基本OpenAPI设置

配置通过OpenAPI建立通信的设置。

1
在Web Connection的管理员模式下(或在本机的[机器设置]-[管理员]中)选择[网络]-[SSDP设置]，然后配置SSDP设置。

- 有关设置的详细资料，请参见[SSDP设置]设置(在此步骤后叙述)。

2
在Web Connection的管理员模式下(或在本机的[机器设置]-[管理员]中)选择[网络]-[OpenAPI 设置]-[OpenAPI 设置]，然后配置OpenAPI设置。

- 有关设置的详细资料，请参见[OpenAPI 设置]设置(在此步骤后叙述)。

[SSDP设置]的设置

设置 | 说明
--- | ---
[SSDP] | 启用SSDP时，请将该选项设置为开启(默认值为开启)。 这样可以实现以下效果： 通知已在本机开启的OpenAPI服务。 返回搜索OpenAPI服务的响应信息。
[多点传送TTL设置] | 如有必要，更改SSDP多播信息包的TTL (存活时间) (默认值为[1])。

[OpenAPI 设置]的设置

设置 | 说明
--- | ---
[端口号] | 如有必要，请更改OpenAPI通信的端口号(默认值为[50001])。
[HTTP版本设置] | 选择HTTP通信的协议版本(默认值为[HTTP/1.1])。 [HTTP/1.1]：仅使用HTTP/1.1。 [HTTP/2,HTTP/1.1]：连接到HTTP/2时使用HTTP/2。在其它情况下，使用HTTP/1.1。

提示

- 如果在Web Connection中或本机屏幕上同时更改多个端口号，将会出现端口号重复错误。如果出现端口号重复错误，请逐一更改多个端口号，不要同时更改。

### 使用代理服务器

当在您的环境中安装了代理服务器时，请注册代理服务器。

在Web Connection的管理员模式下(或在本机的[机器设置]-[管理员]中)选择[网络]-[OpenAPI 设置]-[OpenAPI 设置]，然后配置以下设置。

设置 | 说明
--- | ---
[代理设置] | 注册代理服务器以适合您的操作环境。 [代理服务器地址]：输入代理服务器地址。采用下列任意一种格式。 输入主机名的示例："host.example.com" 输入IP地址(IPv4)的示例："192.168.1.1" 输入IP地址(IPv6)的示例："fe80::220:6bff:fe10:2f16" [代理服务器端口号]：如有必要，更改用于HTTP的代理服务器端口号(默认值为[8080])。 [代理服务器端口号(HTTPS)]：如有必要，更改用于HTTPS的代理服务器端口号(默认值为[8080])。 [代理服务器端口号(FTP)]：如有必要，更改用于FTP的代理服务器端口号(默认值为[21])。 [用户名]：输入用于代理认证的用户名(最多可使用63个单字节字符)。 [密码]：输入用于代理认证的密码(最多可使用63个单字节字符)。

### 使用SSL通信

使用SSL加密本机与应用程序之间通过OpenAPI建立的通信。

1
注册本机证书并启用SSL通信。

- 有关详细资料，请参见使用SSL/TLS通信。

2
在Web Connection的管理员模式下(或在本机的[机器设置]-[管理员]中)选择[网络]-[OpenAPI 设置]，然后配置SSL设置。

[OpenAPI 设置]的设置

设置 | 说明
--- | ---
[SSL/端口设置] | 选择通信时是否使用SSL (默认值为[仅限非-SSL])。 [仅限非-SSL]：仅允许非SSL通信。 [仅限SSL]：仅允许SSL通信。 [SSL/非-SSL]：允许SSL通信和非SSL通信。
[端口号(SSL)] | 如有必要，请更改SSL通信的端口号(默认值为[50003])。
[证书验证等级设置] | 如需在SSL通信中验证证书，请选择需要验证的项目。 [客户端证书]：选择是否要求连接至本机的客户端提供证书(默认值为关闭)。 [有效期]：确认证书是否处于有效期内(默认值为开启)。 [CN]：确认证书的CN (公用名)是否匹配服务器地址(默认值为关闭)。 [键使用方法]：确认证书的使用是否符合证书发行机构的目标用途(默认值为关闭)。 [链式]：确认证书链(证书路径)是否存在问题(默认值为关闭)。系统参照本机管理的外部证书验证证书链。 [过期确认]：确认证书是否过期(默认值为关闭)。按照先OCSP (联机证书状态协议)服务，再CRL (证书吊销列表)的顺序执行过期确认。

提示

- 如果用户认证方法设为[开启(外部服务器)]或[开启(MFP + 外部服务器)]，则[SSL/端口设置]同步更改为[仅限SSL]。

参考

- 验证通讯对方的证书

# 书签

如果单击或触摸页面右上方的，则会变为并且注册为书签。

# 按标题筛选

可以从本使用说明书的菜单中缩小搜索范围。
可以选择多个选项。

# 选择并打印

选择想要打印的项目，然后单击打印按钮。