You are here: Home / Additional modules / API-Modul

API-Modul

Via the onOffice API you can read and also change address and property data in onOffice enterprise – e.g. when using the“onOffice for WP Websites” plugin for Wordpress pages.

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 Icon New record record” icon.

Create users

In the field “Save as:” please select “API user”.

Create user as 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.

Newly created API user

Click on the “Update update ” icon here to generate API tokens and Secret.

Token and Secret for the API user

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 .

Rights settings for API users

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).

property

Properties can be released in the property detail view >>  Marketing tab
Marketing the property on your own website
Please set the “Publish” option to “yes” in the category “Own website”.

Addresses

To be able to release addresses for the API user, you must make the following settings in administration (Tools >> Settings >> Administration >> Input fields >> Module addresses >> Category Administration) activate the field “homepage_veroeffentlichen”.

On the tab, first select “Address management” for the module and “Administration” for the category. Please activate the field “homepage_veroeffentlichen” here.

Activate publish address in the administration

Now you can share the address data record in the “Administration” category on the “Basic data” tab in Addresses.

Publish address on websites

API-Modul