The Kofax TotalAgility Application Programming Interface (API) documentation includes the following:

• The details of the supported APIs including deprecated methods.
• A list of supported methods for each service.
• All inputs and outputs including the required fields, field types, and enumerations.
• Any special information pertaining to the method.
• Some coding examples.
• Details behind concepts used.

Note: Only APIs documented in the SDK documentation are supported for use. Any APIs not documented in the SDK documentation are not supported for use and are subject to change without notice.

Important:

• TotalAgility On-premise Multi-Tenancy and TotalAgility Azure do not support using the TotalAgility SDK API from custom .NET assemblies executed through .NET activities or .NET form actions because the custom .NET assemblies run in a non-trusted sandbox in TotalAgility On-premise Multi-Tenancy and TotalAgility Azure.
• You can directly call the TotalAgility SDK API from the .NET activities or .NET actions in TotalAgility On-premise Multi-Tenancy and TotalAgility Azure.
• TotalAgility provides both HTTP SOAP XML and HTTP JSON services. The HTTP JSON services do not use SOAP or XML; every request is a HTTP POST with a JSON payload. The services and methods for HTTP JSON are similar to HTTP SOAP XML. The HTTP JSON services are not strictly RESTful services as they do not use every HTTP verb (GET, PUT, POST, DELETE); they only use HTTP POST. However, any client that does not support SOAP can use the HTTP JSON services if they are able to do a HTTP POST passing in a JSON payload.