...
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 from a shortcut in the side menu but also from https://dde.alterian.net/docs/
...
Application API
Users generally wont need to access this part of the API, there are however a few areas which may be of interest for example the info APIs allow users to generate reports against the system and the rule APIs allow access to the programmatic management of rules and data grids.
Published Rule API
The Alterian CX platform allows users to create their own rule APIs based of easy building blocks in an easy to use low code interface take a look at Journey Orchestration for full documentation on creating rules. Once a rule has been created it will appear in the Rule API documentation where it can be tested and executed 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 wll appear listed in the help and separated by client (if you have access to more than one client) and target (dev, test, prod).
...
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.