Domains

This feature has been introduced since version 23.2

Introduction

When designing frontend for a multitenant environment there are two variants

  • There is a single front-end URL, e.g. archief.viaa.be serving multiple organisations/tenants.

  • There are multiple front-end URLs, e.g. zwevegem.mediahaven.com and interwaas.mediahaven.com each serving a specific organisation/tenant on the SAAS installation

Domains

  • To store on each domain what organisation corresponds to it, we have introduced a new API endpoint /domains

Tenant-info

For public front-ends such as a portal or dissemination site that does not have a logged user with the ability to make API calls, we have introduced a new endpoint separate from the REST API to obtain the domain information. This endpoint returns the domain of the primary organisation of the installation.

API Key

You case use the API key returned by the domains or tenant-info endpoint, to make requests using the portal-api. In the API key requests you must use the following options:

  • Key: The literal “key:

  • Value: the actual API key

  • Pass via query