Using OpenAPI
Setting flow
To use application that communicates with this machine via OpenAPI, configure the OpenAPI settings of this machine.
If a certificate for this machine is registered, you can use SSL to encrypt communication between this machine and a client when the machine acts as a server.
By using the Simple Service Discovery Protocol (SSDP) function of this machine, you can associate with OpenAPI connection application smoothly.
To perform the association via OpenAPI, follow the below procedure to configure the settings.
3
Configuring settings to suit your environment
Configure the basic OpenAPI settings
Configure settings to establish a communication via OpenAPI.
1
Select [Network] - [SSDP Settings] in administrator mode of Web Connection (or in [Utility] - [Administrator] of this machine), and configure the SSDP settings.
For details on settings, refer to the [SSDP Settings] settings (described after this procedure).
2
Select [Network] - [OpenAPI Setting] - [OpenAPI Setting] in administrator mode of Web Connection (or in [Utility] - [Administrator] of this machine), and configure the OpenAPI settings.
For details on settings, refer to the [OpenAPI Setting] settings (described after this procedure).
Settings of [SSDP Settings]
Setting | Description |
|---|---|
[SSDP] | When enabling SSDP, set this option to ON (default: ON). This allows for the following actions:
|
[Multicast TTL Setting] | Change TTL (Time To Live) for SSDP multi-cast packet if necessary (default: [1]). |
Settings of [OpenAPI Setting]
Setting | Description |
|---|---|
[Port No.] | If necessary, change the port number for OpenAPI communication (default: [50001]). |
[HTTP Version Setting] | Select the version of the protocol for HTTP communication (default: [HTTP/1.1]).
|
Tips
- If you change multiple port numbers collectively in Web Connection or on the screen of this machine, a port number duplication error may appear. If a port number duplication error appears, change multiple port numbers one by one instead of changing them collectively.
Using a proxy server
When a proxy server is installed in your environment, register the proxy server.
Select [Network] - [OpenAPI Setting] - [OpenAPI Setting] in administrator mode of Web Connection (or in [Utility] - [Administrator] of this machine), and configure the following settings.
Setting | Description |
|---|---|
[Proxy Settings] | Register the proxy server to suit your operating environment.
|
Using SSL communication
Use SSL to encrypt communication between this machine and application via OpenAPI.
1
Register a certificate for this machine and enable SSL communication.
For details, refer to Using an SSL/TLS Communication.
2
Select [Network] - [OpenAPI Setting] in administrator mode of Web Connection (or in [Utility] - [Administrator] of this machine), and configure the SSL settings.
Settings of [OpenAPI Setting]
Setting | Description |
|---|---|
[SSL/Port Settings] | Select whether to use the SSL for communication or not (default: [Non-SSL Only]).
|
[Port No.(SSL)] | If necessary, change the port number for SSL communication (default: [50003]). |
[Certificate Verification Level Settings] | To validate the certificate during SSL communication, select items to be verified.
|
Reference
in the upper-right of a page, it turns into 
and is registered as a bookmark.