HomeDescriptions of Functions / Utility KeysOpenAPI Setting

OpenAPI Setting

To display:
  • [Utility]
    • [Administrator]
      • [Network]
        • [OpenAPI Setting]
          • [OpenAPI Setting]

Configure the OpenAPI communication port and SSL communication settings.

Setting

Description

[SSL/Port Settings]

Select whether to use the SSL for communication or not (default: [Non-SSL Only]).

  • [Non-SSL Only]: Only non-SSL communication is allowed.

  • [SSL Only]: Only SSL communication is allowed.

  • [SSL/Non-SSL]: Both SSL communication and non-SSL communication are allowed.

[Port No.]

If necessary, change the port number for OpenAPI communication (default: [50001]).

[Port No.(SSL)]

If necessary, change the port number for SSL communication (default: [50003]).

[HTTP Version Setting]

Select the version of the protocol for HTTP communication (default: [HTTP/1.1]).

  • [HTTP/1.1]: Uses HTTP/1.1 only.

  • [HTTP/2, HTTP/1.1]: Uses HTTP/2 when connected to HTTP/2. In other cases, HTTP/1.1 is used.

[Proxy Settings]

Register the proxy server to suit your operating environment.

  • [Proxy Server Address]: Enter the proxy server address. Use one of the following formats.
    Example to enter the host name: "host.example.com"
    Example to enter the IP address (IPv4): "192.168.1.1"
    Example to enter the IP address (IPv6): "fe80::220:6bff:fe10:2f16"

  • [Proxy Server Port Number]: If necessary, change the proxy server port number to be used for HTTP (default: [8080]).

  • [Proxy Server Port Number (HTTPS)]: If necessary, change the proxy server port number (default: [8080]).

  • [Proxy Server Port Number (FTP)]: If necessary, change the proxy server port number to be used for FTP (default: [21]).

  • [User Name]: Enter the user name used for proxy authentication (using up to 63 characters).

  • [Password]: Enter the password for proxy authentication (using up to 63 characters).

[Certificate Verification Level Settings]

To validate the certificate during SSL communication, select items to be verified.

  • [Client Certificates]: Select whether to request a certificate from clients that connect to this machine (default: OFF).

  • [Expiration Date]: Confirm whether the certificate is within the validity period (default: ON).

  • [CN]: Confirm whether CN (Common Name) of the certificate matches the server address (default: OFF).

  • [Key Usage]: Confirm whether the certificate is used according to the intended purpose approved by the certificate issuer (default: OFF).

  • [Chain]: Confirm whether there is a problem in the certificate chain (certificate path) (default: OFF). The chain is validated by referencing the external certificates managed on this machine.

  • [Expiration Date Confirmation]: Confirm whether the certificate has expired (default: OFF). The expiration date confirmation is performed in the order of OCSP (Online Certificate Status Protocol) service, and CRL (Certificate Revocation List).

[Access Setting]

When enabling an access from an application via OpenAPI, set this option to ON (default: ON).

[Authentication]

When authenticating users accessing via OpenAPI, set this option to ON (default: OFF).

  • [Login Name]: Enter the login name used for OpenAPI authentication (using up to eight characters).

  • [Password]: Enter the password for OpenAPI authentication (using up to eight characters).

[External Application Connection]

Specify whether to connect to external application via OpenAPI (default: [ON]).

[Specified Application Start Setting]

When launching only the pre-specified OpenAPI application at start-up of this machine, set this option to ON (default: OFF).

  • [Default Startup Application Selection]: Specify the OpenAPI application to start (default: [Do not start.]).

  • [Basic Functions Setting]: When using the basic functions of this machine, set this option to ON (default: OFF).