Portflow provides a powerful REST API that can be used to interact with almost all database tables.

Specifications:

• REST API
• based on the OpenAPI 3.1
• uses CRUD system (Create, Read, Update, Delete)
• supported methods: POST, GET, PATCH, PUT, DELETE
• authentication via session as user or via API key as application

Restrictions:

• interaction with the database table 'access', which is used for ACL (AccessControlListing), is not permitted
• interaction with the database table 'api', which is used to store the API keys, is not permitted
• interaction with the database table 'users', which is used to store user account data, is not permitted

Meaning:

Portflow uses the API for internal actions; therefore an API token is created for Portflow during setup, which must not be removed. The API is the central interface for requests to the database.

Usage:

Create API key in Portflow (Settings -> ACL -> API), define authorizations

Translated with DeepL.com (free version)