Services
This section defines services that are included in the RSO-API.
The following are the services defined:
The different services are described from a general perspective which includes the operations. For implementation and details about all of the entities, see the data-schema files or the .NET SDK assemblies.
Accounts
The account service is used to manage the organizational accounts within Kofax AP Essentials. From here, you can preform operations on Partner, Customer and Buyer Accounts. Typical operations are to create Customer and Buyer Accounts and to activate them before usage.
Base URL
Authentication
The authentication service is used to authenticate a user to the user-management system within Kofax AP Essentials. When authenticating a user, the user name and password must be provided.
Base URL
Documents
Operations in the document service operate on documents and batches within the Document Repository. The service is mainly used to retrieve extracted data files and image files from Kofax AP Essentials. For integrations where the verification is performed outside of Kofax AP Essentials, you can send data to Kofax AP Essentials, so the document auto-learning process is performed.
When downloading documents through the API, it is important to set the Output target to “API”.
Base URL
Files
This service provides a way to upload images (for example, TIF and JPG images) and other files (such as PDF) to Kofax AP Essentials. After the file is uploaded, the data extraction takes place (depending on configuration).
Base URL
Masterdata
Master data can be used to validate business information in the system during the manual user steps. A typical usage is to send supplier master data to Kofax AP Essentials so it is available during the verification.
Base URL
Metering
This service provides ways to observe document status, history and other document details.
Base URL
Privileges
This service provides operations on the privilege entity in the system.
Privileges are assigned to a specific user, but can also be connected to a certain role which is used to assign a specific set of privileges to users. This service is mostly for internal usage.
Base URL
Roles
This service provides operations on the roles within the system.
Base URL
Users
This service provides operations for user management. Typical usage is to create users and administrators from an external system.
Base URL