Software Development Kit

CodeTwo Exchange Rules Software Development Kit (SDK) provides documentation, samples and libraries containing classes representing API (based on Windows Communication Foundation Service working over the HTTP protocol) provided by CodeTwo Exchange Rules Pro that let you develop and build service-orientated custom applications integrated with the program.

Info

Important: CodeTwo Exchange Rules SDK is available in a separate package from CodeTwo Exchange Rules Pro. To make use of it, you need download the installation package from our website. Furthermore, documentation describing this SDK in detail is available here.

The SDK can be used to build three different types of custom apps integrated with CodeTwo Exchange Rules Pro:

  • Web apps e.g. ASP.NET, Java EE.
  • Desktop apps e.g. Windows Forms, WPF.
  • Mobile apps e.g. Android/iOS using Xamarin.

No matter which type of custom application you want to build, you can implement the following features of CodeTwo Exchange Rules Pro in the app:

  • Create and modify rules
  • Add actions to rules
  • Add conditions and exceptions to rules
  • Create and modify tenants
  • Modify splitting of messages

The diagram below shows how the created custom app cooperates with the Windows Service installation of CodeTwo Exchange Rules Pro using the provided API (Fig. 1.):

ER Pro 2.x - Scheme of communication: CA - Pro.
Fig. 1. Scheme of communication between the custom app and CodeTwo Exchange Rules Pro.

Warning

CodeTwo Exchange Rules SDK is compatible with CodeTwo Exchange Rules Pro version 2.0.12 onward. Therefore, it cannot be used to build custom application integrated with the program prior to this version.

Was this information useful?