Haiilo offers a REST API, allowing developers to make custom or bulk changes and tailor the platform to their specific requirements.

Features

• API documentation: You can view all the endpoints and the possible requests you can make in Haiilo's API documentation. Select your platform version in the upper-right corner of the documentation to view only the relevant endpoints for your platform version. Learn more in this resource:
  
  • REST API documentation
• Authentication: Authentication for the REST API is based on OAuth2. Every call to the REST API is made on behalf of a user. A user is authenticated with an OAuth2 access token. This allows the server to check whether the authenticated user can access the requested resource, ensuring Haiilo's permissions model. Learn more in this resource:
  • REST API documentation > Authentication
• Use cases: We have compiled a list of common use cases for which the API can be used. Learn more in the individual articles:
  • API: Customizing profile fields
  • API: Importing translations
  • API: Customizing the order of search results
  • API: Changing the password policy
  • API: Managing users

Permissions

These are the permissions related to the API:

• "Manage API clients": Allows users to create and manage API credentials for making authentication requests to the API.

A user calling the API has the same permissions in the API as when logged in on the web. Therefore, your permissions and role in Haiilo affect what you can do with the API. For full access, activate moderator mode while logged in as a superadmin.