Skip to main content

How to Get Started with the Flexi API 1/6 - Introduction to REST API

Introduction to the ABRA Flexi REST API series: what the interface is for, what you need before you start, and what daily request limits apply

Written by Petr Pech

In addition to the desktop and web application, ABRA Flexi offers a third way to access your data: the REST API. Through it, you can read, create, update, and delete records, and use most of the functions you know from the application.

The REST API is most useful for connecting Flexi with another application, typically an e-shop, CRM, or warehouse system. This series will walk you through the basics: what to call the API with, how to build the address, which operations and formats are supported, and what specific request examples look like.

⚠️ Access to the REST API is not automatically included in the license; it is purchased separately. Without purchased access, you cannot use the interface. For details, see the article licensing API access.


What the REST API can do

Through the REST API, you work with the same data as in the application, just in a machine-readable way:

  • read records from individual records lists, such as issued invoices, address book, price list, or stock cards

  • create new records and update existing ones

  • delete and cancel documents

  • export data in various formats, including printed reports in PDF

The extent of what you can see and change through the API is governed by the permissions of the user account you log in with. So the interface cannot be used to bypass settings that also apply in the application.


What you need before you start

  • A license with purchased API access and a user account set up specifically for the API

  • The server address and the identifier of the company you will be connecting to

  • A tool for sending requests, such as Postman, cURL, or your own script


Daily request limit

The number of API requests per day is limited and varies depending on your license plan:

License plan

Number of API requests included

Volume increase

ABRA Flexi Basic

5,000 / day

cannot be added

ABRA Flexi Business

10,000 / day

can be purchased

ABRA Flexi Premium

20,000 / day

can be purchased

For the Business and Premium plans, you can purchase additional request volume beyond the limit. Current prices can be found in the price list.

ℹ️ If the limit is exceeded, the server will reject further requests and return a 429 error. The article on recommended practices for working with the API describes how to design your queries so they comfortably fit within the limit, and how to properly handle error states.


Series contents


Where to go next

Once you've completed this series, there are two follow-up directions you can take:

  • API Ninja is a hands-on training series with its own test environment, where you can try out each procedure directly.

  • REST API Documentation serves as a complete reference guide to all parameters, operations, and formats.

💡 If you're not sure how to use the API in your specific scenario, you can arrange an individual consultation, where we'll help you design your integration.

Did this answer your question?