Introduction
Use the application programming interface to consume ReST API app configurations.
There are numerous client-side applications for Flexiva, all with different styles, themes, colours etc.. and written using a variety of programming languages, frameworks and UI libraries.
This API documentation is aimed primarily at staff and partners who are continually innovating new types of applications, however customers are also invited to build their own custom applications using our API.
This API can be used to build new client-side applications, or server-side automation.
Architecture of a New Flexiva Application
This diagram shows the architecture of how a new client-side application would fit into the Flexiva platform:

All ReST API’s are connected to Flexiva Web API.
The Flexiva back-end database is also accessible through the same Web API. This is where the configuration for each customer is stored.
Flexiva App Studio provides a suite of configurators to customise each customer app. It reads and writes to the Flexiva Web API. It communicates with third party ReST API’s also via the Flexiva Web API.
New client-side app gets all customer configuration from the Flexiva Web API. It makes CRUD data requests to third party ReST API’s also via the Flexiva Web API.
This architecture frees new client-side apps from worrying about the complex business logic programmed into the back-end ReST API's and each respective custom configuration designed by business specialists. This is the 'separation of concerns' principle, allowing the developer to build a compelling client-side back-end independent front-end application with the worlds current favourite programming language, framework or user interface component library.
API Endpoint
The endpoint for the API is https://api.trisys.co.uk
API Key
The API key for developing against the API is 20241002-re90-9e2c-2904-flexiva.app.
When you move your client-side app into production, we will supply you with a unique key to allow you to monetise your app, or impose tight security rules to limit its use.
Methodology
The API abstracts the complexity of the underlying application configuration, and is used both by the App Studio to configure the client-side CRUD business app, but also used at run-time by the client-side CRUD business app to 'draw' the user interface and present and capture CRUD data via forms.
Login Authentication and Logoff
The end-user must be authenticated either via an e-mail address plus password combination, or via a social network login previously configured by the end-user. If the user has turned on two-factor authentication, then your application must be able to capture and validate this also before allowing users to access their data. The end-user should also be logged off when they request.
Password Reset
Your application will also have to deal with the password reset process to allow end-users who have forgotten their password to reset it.
User Interface Container
Your application must take responsibility for drawing the full UI container including the navigation bar, toolbar, add menu, history menus, custom buttons, activity metrics and F1 help.
The App Studio uses the Font Awesome and Glyph Icons Pro collections for icons assigned to navigation bar, buttons, forms and menus so either these should be available, or a mapping to a similar icon set should be provided.
Forms Subsystem
Your application must also take responsibility for loading custom CRUD forms for both lookup and data entry by understanding the API's relating to the designed forms containing components and fields.
UI Widgets
Your application will probably use its own framework or component library which contains UI widgets such as grids, calendars, date pickers, combo boxes etc.. You will need to be able to map the intrinsic form designed components and fields with your UI widgets.
Custom Variables
Custom variables weld front-end forms with back-end data so your application will need to utilise these to ensure that data is passed between the layers of the application.
Data Source Requests
Your application will need to use the data requests specific API's for all CRUD operations.
Security
You will need the security API's to determine what elements of the designed application are to be made available to which end-user.
Artificial Intelligence
The comprehensive architecture and design of Flexiva plus this extensive API technical documentation will fully support the use of large language model (LLM) generative AI tools to construct client-side applications using the API.
As this LLM ecosystem evolves, and new UI innovations are devised, using AI to generate client-side applications directly from this specification will be possible.
We are very excited to provide this capability to our partners and customers, who understand the importance of future proofing business software.
Last updated