AireGlu

Appearance

Endpoints ​

Endpoints define and shape the functionality that AireGlu provides. They are called by external applications or other endpoints, and perform various tasks as configured. These can range from manipulating and shaping data, or sending an email, to generating a PDF, to contacting other external services. Custom tasks can also be created via the use of adapters.

Building an Endpoint ​

The Getting Started page has a quick setup for a simple endpoint. You should check there for something simple. This guide will go more in depth about the various options available during creation.

Endpoint Name is required, and forms part of the URL for the endpoint. If glu.aireinnovate.com is our AireGlu instance, and airelogic is our tenant, then our full endpoint URL would be https://glu-api.aireinnovate.com/airelogic/ENDPOINT-NAME. The name only allows letters, numbers and hyphens (-) to be used.

Group Name is an optional field and does not affect how the endpoint runs. You can choose to add groups for your endpoints, and then on the endpoint page choose to see your endpoints within their groups. Any endpoints without a group will be shown in the Ungrouped Endpoints group

Error Email is optional. It is used to report the following during endpoint execution:

  • There was an input validation error
  • Running endpoint resulted in an AireGlu exception
  • The endpoint returned a non-success status code

Authentication ​

You can require authentication for your endpoint to limit availability and use. See Endpoint Authentication for the available methods and how to configure them.

Input ​

In the input dialog, select the data format the endpoint should expect. You can also edit both the example input and the expected schema (with some exceptions). Learn more here.

Tasks ​

Tasks make up the meat of the Endpoint. They are responsible for the processing that goes on. Tasks are covered in detail here.

Stop on Task Failure allows you to stop running the endpoint when a task fails to complete successfully. If this is turned off, then it will ignore failed tasks, and continue to process each subsequent task. Be aware this may cause unpredictable behaviour or more failures if those tasks depend on the output of the failed task.