This section defines services that are included in the RSO-API.

The following are the services defined:

• Accounts
• Authentication
• Documents
• Feedback
• Files
• Masterdata
• Privileges
• Roles
• Users

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

Purpose

The account service is used to manage the organizational accounts within ReadSoft Online. 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

https:// services.readsoftonline.com/accounts/rest

Authentication

Purpose

The authentication service is used to authenticate a user to the user-management system within ReadSoft Online. When authenticating a user, the user name and password must be provided.

Base URL

https://services.readsoftonline.com/authentication/rest

Documents

Purpose

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 ReadSoft Online. For integrations where the verification is performed outside of ReadSoft Online, you can send data to ReadSoft Online, so the document auto-learning process is performed.

Note When downloading documents through the API, it is important to set the Output target to “API”.

Base URL

https:// services.readsoftonline.com/documents/rest

Feedback

Purpose

This service provides a way to send user feedback to ReadSoft Online in case external verification is taking place. This makes it possible to inform the system that interpretation enhancements needs to be done.

Base URL

https://services.readsoftonline.com/feedback/rest/

Files

Purpose

This service provides a way to upload images (for example, TIF and JPG images) and other files (such as PDF) to ReadSoft Online. After the file is uploaded, the data extraction takes place (depending on configuration).

Base URL

https:// services.readsoftonline.com/files/rest/

Masterdata

Purpose

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 ReadSoft Online so it is available during the verification.

Base URL

https://services.readsoftonline.com/masterdata/rest/

Privileges

Purpose

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

https://services.readsoftonline.com/privileges/rest/

Roles

Purpose

This service provides operations on the roles within the system.

Base URL

https://services.readsoftonline.com/roles/rest/

Users

Purpose

This service provides operations for user management. Typical usage is to create users and administrators from an external system.

Base URL

https://services.readsoftonline.com/users/rest/