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 and integrations to the rules created by the users. This documentation is primarily concerned with the Rule 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).
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. Take a look at Calling a CX Rule via the API for more information.
Expanding a rule will provide extra information around how the rule can be invoked and the data expected.
Clicking the Try it out button will allow users to edit the example data and invoke the rule
Executing the rule in the API help also provides further invoke information such as a curl string and request URL.
After the invoke response information is also available.
If the rule is designed to return data to the calling system this will also appear in the response area of the help
