Please note that the API module and the API user are not part of onOffice enterprise edition, but can be purchased as a supplementary product.
Please contact your sales contact person.
Once the API has been activated, a user (API user) must be created in order to use the API.
Create API user
In the list view of users, create a new user by clicking the “new record” icon.
In the field “Save as:” please select “API user”.
Please fill in the field “user name”, otherwise it is not possible to save your data. Please check the user name carefully, as it cannot be changed after it has been created.
Further specifications are not possible when creating. After you have saved, the user is created and opened directly for further editing.
Generate API token and secret
After the API user has been created, the API secret and token are still missing. These are needed so that e.g. website creators have access to the address and property data in onOffice enterprise.
Click on the “Update ” icon here to generate API tokens and Secret.
If an API token has already been generated, the old API token is hereby invalidated.
Please write down the new secret immediately, as it will only be displayed once!
API user rights
On the “Rights” tab, you determine which rights the user is granted.
The API user should get the rights necessary for the desired programming / actions.
In general, the user rights apply as elsewhere in onOffice enterprise .
For the connection to Wordpress sites via the “onOffice for WP-Websites” plugin, the authorization can be restricted to released addresses/properties.
To do this, please check the box “Can only see addresses/properties published on the website”. For more information, see the section “Release of properties and addresses” below.
Release of properties and addresses
If the right “Can only see addresses/properties published on the website” is set, properties and/or addresses must be released for the API user. However, if the right is not set, the release of properties and addresses is controlled by the normal user rights (read/write/delete).
On the tab, first select “Address management” for the module and “Administration” for the category. Please activate the field “homepage_veroeffentlichen” here.
Now you can share the address data record in the “Administration” category on the “Basic data” tab in Addresses.