Please note that this is a premium feature which needs to be enabled by your dedicated customer success manager. For further information, please reach out to your BRYTER Customer Success Manager or email@example.com. Additional pricing may apply.
For advanced security options and better control who has access to your module, you can embed your module via a Private API. Instead of linking the module directly via the URL in an iFrame, you will use the module ID with a dedicated API key. Note that this feature is disabled by default. To access it, please contact your Customer Success Manager.
However, this requires some server-side implementation on your part (or rather your IT department/web agency), but is a flexible way to ensure only people with access to your restricted page can access the embedded BRYTER module.
Secure confidential module data
If your module contains confidential or sensitive data and has to be shared across the internet (outside your private network), using this method will ensure that your data is safe.
Control who has access to your module
Using this method you can precisely control who has access to your module and who doesn't. You could for example restrict usage based on the country of your user. Let's say you have public modules with different jurisdictions. You could show the right jurisdiction based on the country of the user.
How to use the API key
In the publishing settings, select Ony accessible via an API key under Access Settings.
In your Publish side panel, you'll now see the parameters, Module ID and the API key, that will be used in the embedding process later on as described below.
Your unique module ID which is generated by BRYTER and will be used in the embedding process later on.
Your unique API key which is generated by BRYTER and will be used in the embedding process later on.
First activate the "Private through API" setting in the "Share"-modal of your module. This action reveals a Module ID and an API key. Using this ID it is now possible to request a URL for the iFrame
src attribute, that will only allow the creation of a single Wizard session.
Request a secured URL
On your web-server, when loading the page with the BRYTER module embedded, you first need to do the following request to our API:
Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8
In case you need to set the language for the Wizard (e.g. to German), you can modify the payload like this:
Provide URL parameters
In case you are using URL parameter nodes in your module, you can provide these parameters as well:
Handling the response
If the published module exists and the
apiKey is correct, you will receive a response containing the
shareUrl to use as
src for loading the BRYTER module in an iFrame. Since the URL is for one-time use, your web-server needs to request a new
shareUrl for each embedding. Also, do not modify the
shareUrl in any way because we are likely to change its structure without further notice.
A validresponse will look like this:
Other status codes to handle:
400 Bad Request:There has most likely been a mistake in the request body. The response from the server contains more information.
404 Not Found:The module does not exist or the API-key was incorrect. Please check that both are correct and the module is still published.
5xx Server Error:There has been an error on our side in which case we have been notified. Please contact support if the error persists.