General, scope of functions
If, for example, you have created an application to track time, you can access the data group(s) via API and view the time accounts on a smartphone app that consumes the API endpoints.
The distinction between "Application API" and "Administration API"
There are two extensive API functionalities available to you in Intrexx: the Intrexx Application API and the Intrexx Administration API. With the Application API, you can create your own API endpoints for Intrexx applications. The Administration API provides you with a defined set of API endpoints containing central functions for the configuration of Intrexx.
Processes
A description is provided below of the main steps you must take to create and deploy custom API endpoints.
|
|
First, create an application as usual. |
|
Then create the desired API endpoint. To do this, you must have activated the "API endpoints" checkbox under "View" in the main menu. You can create API endpoints for data groups, processes, and Groovy scripts. The methods GET, POST, PATCH and DELETE are available. |
|
|
In the next step, you must assign permissions for each individual API endpoint. You can assign permissions at the application level. When doing so, you must select users who are to be allowed to access the corresponding API endpoint. |
|
|
As an alternative or in addition to application-level permissions, you can also assign permissions using API keys. This requires that an API key first be created and then assigned to one or more API endpoints and a user. |
|
|
These steps set the stage for an API consumer to access an API endpoint. Helpful functions for executing the access to the API endpoint (request) are available via context menus, such as copying the API URL or the API key. |
|
|
Finally, you can create Swagger documentation or a Swagger file in .yaml format. This and the API keys can be passed to an external service provider who is to create an app for a smartphone for you, for example. |
Target group and previous knowledge
The "Application API" feature as well as the associated online help are aimed at users who have a basic understanding of API development. The Application API follows the Open API specification. If necessary, you should familiarize yourself with it.
How to read the online help for the Application API
The first section, Creating Application API endpoints , provides general information about creating Application API endpoints. You will find an overview of the individual dialogs and their functions, general information about path and query parameters and about the structure of the API URL. If you want to familiarize yourself (initially) with the basics of API endpoint creation in Intrexx and need general information on API creation, then it is helpful to read this section first.
However, you can also jump right in with the sections on creating the individual endpoints. There you will find detailed step-by-step instructions for each endpoint type. These will guide you through the individual dialogs and explain what information you need to enter or select in each case.
The step-by-step instructions can be found in the following sections:
The subsequent sections on granting permissions (Assigning permissions), creating API keys (Create and manage API keys), and executing requests (Executing requests) should be read in any case to be able to functionally use the API endpoints you have created.
The Create Swagger documentation section is particularly useful if you want to generate an OpenAPI file in .yaml format and share it with a service provider, for example.
Further information
Below are some links that can help you become familiar with the basics of the API development and related standards:
Email us