Introduction

Design

AzoraOne allows you to integrate self-learning automation directly into your application.

• AzoraOne's API is designed around REST.

• It supports the JSON format.

• It is secured using an Ocp-Apim-Subscription-Key header and a Client-Key header in each request.

• API requests must use the HTTPS protocol. Requests made with HTTP are terminated.

API

All AzoraOne API requests are made to the base URL:

https://api.azora.one/{api}/{version}

The value of the {api} parameter in the URL depends on which API you are trying to access. You can find this value in the API Explorer pages.

• When exploring the sandbox API, the value will be sandbox.

• When you have access to a production API, the value will be your application's name, or an abbreviation of it, for example myaccountingapp. If you have access to a test API, the value will be the production value followed by _test, i.e. myaccountingapp_test.

The value of the {version} parameter in the URL depends on which version of AzoraOne you want to access.

The current version is "v1".

Concept

AzoraOne is centred around the concept of:

1. Adding a file to an existing company

2. Extracting the file

3. Submitting bookkeep data associated with the file

There is no user configuration or setup of rules for AzoraOne to learn what bookkeeping data to extract; instead, AzoraOne learns by being fed the actual bookkeeping data.

Required operations

In order to create a successful integration of AzoraOne you will need to implement the following four operations.

1. Add a company
   Creates a new company that will be used as a container for future file uploads and processing as well as company-specific knowledge (i.e. model pool).

2. Add a file
   Uploads a file to the specified company and prepares it for extraction.

3. Extract a supplier invoice, receipt or customer invoice
   Extracts bookkeeping data from the specified file. This data can be presented to the user as a bookkeeping suggestion.

4. Bookkeep a supplier invoice, receipt or customer invoice
   Adds correct bookkeeping to the specified file to further develop AzoraOne's knowledge on how the company bookkeeps.

You can choose which of the three document types suits your application, but integrating at least one is required. Creating company-specific models on bookkeep is what produces AzoraOne's customised extraction results, so without it the integration provides no benefit.

Creating a company will only have to be performed once per customer. Once created, multiple files can be uploaded to the company. Uploaded files can be extracted and bookkept multiple times.

Optional operations

Once the required operations are working as intended, you can add optional operations that may provide additional value for your customer.

• The suppliers and customers endpoints enable automatic matching of a file to a supplier or customer in your application's supplier/customer lists.

• The patterns endpoint allows users to add deterministic control over sorting of files, by specifying identifiers that may appear on an uploaded file and the destination it should route to in the application. This differs from patching a file's type or verification series, which AzoraOne learns from passively in the background whenever a user moves a file, without the user necessarily being aware that AzoraOne is learning from it. With patterns, the user actively defines the routing rule up front.

• The progenitors endpoint allows users to inherit knowledge from other companies that are already trained.

• The memories endpoint allows users to reset a company's knowledge and start training it from scratch. This affects all users of that company, not just the one who triggers the reset.

• The models endpoint allows users to selectively inactivate models that are no longer wanted.

• Retrieving all files supports filtering and full-text search, so you can build views such as "all unprocessed receipts from last week" without fetching every file and filtering client-side.

• The file details operation lets you retrieve a single file's raw content, OCR'd text, and full extraction and booking history, useful for building a file preview or audit view in your application.

• Requesting a company with metrics set to true returns aggregated processing statistics, useful for dashboards or reporting.

AzoraOne provides many operations that may not add any value to the customer, but are helpful when integrating and testing the service.

You can find a full list of available operations in the AzoraOne Sandbox API below. It contains detailed descriptions for each operation.

Feedback

If you have any suggestions on how to improve the documentation, let us know by sending us an email at support@arkimera.se.