What an API user is
An API user is a separate system user that external systems use to access the Crownbeam API. An API user is required for API access, a personal account cannot be used for it. You create the user yourself and give it exactly the permissions the connected system needs.
You find this area under Settings → My Data → API Management.
Note: API Management is marked as Beta.
How to create an API user
Open Settings using the gear icon in the top right corner.
Under My Data, select API Management.
In the API Users section, click Manage API Users.
Click Create Systemuser in the top right corner.
Enter a Name and use the Description field to record what the user is for.
Select the Language.
Click Create.
Tip: Create a separate API user for each connected system and name it accordingly. That way you can tell at a glance which access belongs to which system, and you can switch off a single connection without affecting the others.
New users then appear in the system user list. Use the search field and the Search button to find a specific user again.
Which permissions are available
The available permissions are listed in API Management under the Available permissions button. Crownbeam discovers this list automatically from the existing API endpoints.
The permissions are grouped by data area, for example Order, Files, Message and Location. Each area offers four actions:
Action | What it allows |
ADD | Create new entries |
CHANGE | Edit existing entries |
DELETE | Delete entries |
VIEW | Read entries |
Every permission comes with a name, a technical codename such as view_order and an ID. As a rule, only the developer who builds the connection needs these details.
Important: Only give an API user the permissions the connected system actually needs. A user that only reads data does not need DELETE.
The rights of your team are handled separately. You still assign them under Settings → My Business → Team, as described in Managing user permissions.
Which APIs are available
Crownbeam provides three REST APIs. Which one you need depends on the perspective the external system works from:
API | Purpose |
Admin API | Administrative tasks. No functions available yet. |
Lab API | Access from the lab perspective |
Practice API | Access from the practice perspective |
You open the overview in API Management using Visit API Portal. For each API you find the documentation, the schema and a Swagger interface for testing there, along with the supported authentication methods.
Note: If you need support implementing an integration, contact [email protected].
FAQs
Can I create an API user myself?
You can create an API user yourself. The path is Settings → My Data → API Management → Manage API Users, then Create Systemuser. You do not need to contact support for this.
Why do I need a separate user for the API?
A separate user is required for the API so that technical access runs independently of personal accounts. This lets you tailor the permissions to the connected system and switch the access off without changing an employee account.
Where do I find the API documentation?
The API documentation is available in the API Portal. You reach it under Settings → My Data → API Management using the Visit API Portal button.