Developing against the Alterian CX API

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.

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.

 

Swaggerhub

 

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.

 

Github SDKs

 

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.

 

Internal Rule Testing

 

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.