Introduction

Welcome to the AzoraOne documentation! Here you will find all the necessary technical information on how to integrate AzoraOne API into your own applications!

Basic design

The AzoraOne API allows you to integrate the AzoraOne self-learning automation functionalities directly into your applications.

  • The API is designed around REST.

  • The API only supports the JSON format.

  • The API is secured by using a Subscription-key and a Client-key in the requests headers.

All AzoraOne API requests are made to the base URL.

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

The value {api} is the abbreviation or short name of your API, as predefined by us. The short name can be found at any operation on the API Explorer pages. The value {version} is your preferred version of the AzoraOne API. Available versions can be found at the Versioning page. The latest version is v1.

Basic concept

The AzoraOne API is centered around the basic concept of adding files to an existing company whereupon bookkeeping data can be retrieved from the file. There is no user configuration or setup of rules in order to learn AzoraOne what data should be extracted. Instead, AzoraOne learns by being fed with bookkeeping data.

Basic operations

In order to accomplish the above, four basic operations are required:

  1. Add a company

  2. Add a file

  3. Extract a supplier invoice or receipt

  4. Bookkeep a supplier invoice or receipt

For any given customer in your application, adding a company is the initial step. This step is performed once per customer. Adding, extracting and bookkeeping files can be performed over and over again:

AzoraOne Steps

Additional operations

Once the basic operations are in place, you can add operations that may provide additional value for you or your customer.

  • To minimize work on your server, you can enable AzoraOne to identify the customer-specific supplier ID of an associated supplier invoice. In order to do this, AzoraOne needs an updated supplier list, you can obtain this by using the Add a supplier operation.

  • The learning of AzoraOne takes place on the company level, only using the basic operations above will mean that each company has to start from scratch. In order to save time and energy for your customer, the Add a progenitor operation allows for transfer of knowledge between companies.

  • You can expand upon AzoraOne's ability to sort incoming files by implementing the Update a file operation.

Of course, AzoraOne provides a bunch of operations that may not add value for the customer but are helpful in your work, such as retrieving, updating or deleting created objects. Obviously, your application does not need to manage all of these operations. Most of them are for you to use to verify that you are doing things correctly when integrating the service into your application.

A full list of available operations in the AzoraOne API includes:

  • Companies

    • Add a company

    • Retrieve a company

    • Retrieve all companies

    • Update a company

  • Files

    • Upload a file

    • Retrieve a file

    • Update a file

  • Receipts

    • Extract data from a receipt

    • Bookkeep a receipt

  • Supplier invoices

    • Extract data from a supplier invoice

    • Bookkeep a supplier invoice

  • Suppliers

    • Add a supplier

    • Retrieve a supplier

    • Retrieve all supplier

    • Update a supplier

    • Delete a supplier

  • Progenitors

    • Add a progenitor

    • Retrieve a progenitor

    • Retrieve all progenitors

    • Update a progenitor

    • Delete a progenitor

  • Memories

    • Delete all memories

The API Explorer contains detailed descriptions for each operation.

Feedback

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

AzoraOne is a product developed by Arkimera Robotics.