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.
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