API
An application program interface (API) is a tool that provides access to the components of an application (e.g., tables, records, imports, user administration, etc.), making it easier for a developer to interact with its configuration and accomplish a specific task.
The API has an interactive documentation page that you need an API-enabled user account to use. Please contact IS Tools support to request access.
Access rights
When the API is used, access rights are checked. This means that the API user must be assigned roles with appropriate field and record group rights access in order to see data, just like an ordinary user. For example:
Endpoint |
Access rights |
/users |
“View” permission for “User administration” in Form rights. |
/fields |
“S” permission in Field rights, and "Select" permission in Record group rights. |
/tables/{tableId}/records |
“S” permission in Field rights, and "Select" permission in Record group rights. |
datalog section |
“S” permission in Field rights, and "Select" permission in Record group rights. |
repimp section |
“View” permission for “Report and import queue” in Form rights. |
extlog section |
“View” permission for “Extended logs” in Form rights. |
application section |
"Select" permission in Record group rights. |