Installing the CallAPIs

As an administrator, you install the CallAPIs to trigger processes in an AE system from external systems by using the Automation Engine scripting language. You can use them either with your own program, or with a utility. A CallAPI is limited to 32000 characters, as are all scripts in the Automation Engine scripting language.

Tip: Consider using the REST API instead of the CallAPI in some cases. The REST API has a /scripts endpoint that covers Call API functions. For more information, see REST API.

Important! The communication between the Java Communication Process (JCP) and the Proxy uses TLS/SSL exclusively. Because the CallAPI does not natively support TLS/SSL and still connects to the Communication Process (CP), it cannot connect directly to the Proxy nor the JCP). However, you can route CallAPI connections through the TLS Gateway to secure them. For more information, see TLS Gateway. The exceptions are the Java and SAP CallAPIs which already use TLS/SSL to connect to the Automation Engine. They communicate directly with the JCP and use trusted certificates to authenticate their identity to other communication partners.

More information:

For additional information about the different certificate types and examples of how they could be created and used, see What Kind of Certificates Should I Use for Automic Automation v21.

Important! Please note that these are only examples, not a requirement for Automic Automation and they are not meant to replace the product documentation.

In Automic Automation Kubernetes Edition, CallAPIs establish a connection to a TCP load balancer. The address of this load balancer must be configured on both ends—the Automation Engine and the CallAPI. The only exceptions are the Java and SAP CallAPIs, which must be updated to use TLS/SSL when connecting to the Automation Engine. These two CallAPIs establish a direct connection to the Java Communication Process (JCP) through an HTTPS load balancer. In this setup, you can also route the connections of the other CallAPIs through the TLS Gateway to securely reach the HTTPS load balancer.

More information:

System Overview

Click the image to expand it.

This section includes the following pages:

Note: Only a subset of the components listed is available for Automic Automation Kubernetes Edition. For more information, see Installing the Additional Components - Container-Based Systems.