...
There are two core APIs available for users of Journey Orchestration. The first is the application API. This API is primarily concerned with driving the product. It provides resources to the user interface and integration points with the rest of the platform.
The second API is the Rule API and is concerned with exposing endpoints
...
to the rules created by users. This documentation is primarily concerned with the
...
Rules API.
The APIs provided are all REST based and are self-documented using swagger, the APIs are accessible in swagger from a shortcut in the side menu.
Published Rule API
The Alterian CX platform allows users to create their own rules in an easy to use low code interface using Templates as building blocks. More information on building Rules within Journey Orchestration can be found in the Journey Orchestration section.
Once a rule has been created it will appear in the Journey Orchestration API where it can be executed and tested through the swagger user interface.
The Rule API interface can be accessed through the link at the bottom of the documentation page or directly from https://dde.alterian.net/docs/rules.html
...
Rules are separated by client (if you have access to more than one client) and the target (dev, test, prod) they are saved and are listed alphabetically within these groupings.
...
Published rules can appear as both POST and GET although generally POST is the most common. For a POST rule when the API is invoked data is passed in the body of the POST message. Authentication can be enabled where necessary with an API key in the header of the request.
Calling a CX Rule via the API contains more information on the authentication process.
Application API
...
If you have been tasked with working with the Alterian API, we provide various convenient facilities to streamline the process. This guide outlines the resources available, including documentation, SDKs, and integrated testing within the Alterian CX environment.
Accessing APIs and Documentation
The Alterian APIs are accessible and comprehensively documented on Swaggerhub. This platform offers a clear overview of all available APIs, their usage, and how they interoperate. Developers can access the documentation here: Swaggerhub.
Software Development Kits (SDKs)
To facilitate development across various platforms, Alterian publishes SDKs on GitHub. These SDKs are available for Java, JavaScript, and C#, providing developers with pre-built tools and functionalities. The SDK repository can be found here: GitHub.
Integrated Testing within Alterian CX
In addition to external resources, Alterian CX offers access to the API directly within its environment. This feature simplifies testing, especially when the Rule Designer's testing function lacks the necessary capabilities. Developers can seamlessly test and validate their implementations within the Alterian CX platform. Please see published rule testing for more information.