Adaptiva API Foundry & SDK Overview

In this article:

Overview - Basic overview of the Adaptiva API Foundry & SDK

Overview

Adaptiva has a unique capability in being able to convert a workflow into an API. We call this facility the 'API Foundry'. This removes the usual restrictions of predetermined interoperability with certain exposed functions within a product and allows the administrator the ability to create their own APIs for interacting not only with parts of the core product itself, but also other applications and services.

The API Foundry is made up of two components.

1) The existing workflow designer that is used to create the API
2) The Adaptiva SDK which consists of either 1 or 2 dynamic link libraries (.dlls) for calling the API through managed code.

The latest version of the SDK can be found on any Adaptiva client running Adaptiva version 5.6 or later. You will find the files in the bin directory.

Under the bin directory there will be separate folders for 32-bit and 64-bit. The correct DLLs should be used for the architecture of the operating system that the code will run on.

For earlier versions of the Adaptiva, the libraries can be downloaded using the link at the bottom of this article.

The combination of these two DLLs allows a wide range of programmatic invocation of APIs. The AdaptivaAPIFoundry.dll is the core runtime library, written in C++ that contains the methods required for programmatic access. This can be used directly by any application that can make method calls from a C++ DLL.

Additionally, on top of that, a .NET DLL has been created that allows easier direct execution using any .NET-based programming language such as VB.NET, C#, PowerShell etc. This DLL can be added as a reference to a project for easy access to .NET objects.

For detailed instructions on how to use the API Foundry, please see the usage guide.