6.1 Workflow for using an API
You can use APIs released for JP1/AJS3 to execute or monitor a JP1/AJS3 - Manager unit from a user application. The following describes the workflow for using an API.
You can create a user application by using a programming language that can perform HTTP communication. To have a user application issue a request, specify the authentication information of the JP1 user. After a request is issued, the request is passed through the Web Console server and JP1/AJS3 - Manager, and then user authentication is performed by JP1/Base. If authentication is successful, processing is executed on JP1/AJS3 - Manager, and the response is returned to the user application. This authentication is performed every time a request is issued. The following figure shows the workflow of this processing.
|
|
![[Figure]](GRAPHICS/ZO060010.GIF)
For details about what can be performed by using APIs, see 8.3 Operating JP1/AJS3 by using user applications in the manual JP1/Automatic Job Management System 3 Overview.
- Supplementary note
-
-
The communication protocol used by APIs is HTTP/1.1. For details about the communication protocol, see the following specifications:
For the HTTP protocol:
RFC2616
For the HTTPS protocol:
RFC2818
-
JP1/AJS3 also allows you to restrict the execution of APIs from a user application and restrict the JP1/AJS3 - Manager instances to which requests can be issued.
You can enable the functions for restricting the execution of APIs and for restricting connection-destination JP1/AJS3 - Manager instances by changing the settings in the environment settings file (ajs3web.conf) of the Web Console server. For details about the environment settings file (ajs3web.conf) in Windows, see 3.4.3 Details on the settings in the environment-settings file (ajs3web.conf) in the JP1/Automatic Job Management System 3 Configuration Guide. For details about the environment settings file (ajs3web.conf) in Linux, see 13.3.3 Details on settings in the environment-settings file (ajs3web.conf) in the JP1/Automatic Job Management System 3 Configuration Guide.
-