fepli
ManualReferenceApp-StoreAdmins

Embed in a website

With the app Embed in a website, other websites show offers as an embed.

Location: Settings > App-Store > card Embed in a website. Visible to: super admins.

Group: API & embedding, included. Provider: none. The embeds belong to fepli.

Catalogue, states and structure of an app are described in App-Store.


What the app does

In the section What it does
“Delivers the offer list, an offer and the registration card as a building block for other websites.”
“Lets a block run only on the websites its public key is valid for.”
In the section How to use it
“Every season and every offer has the new tab “Embed”, with the code to copy.”
“You create the public keys for it down here.”

Card in the catalogue: “The town’s website shows your offers as a building block: copy the code, paste it.”


Behaviour

FeatureContent
AccessNo credentials
DefaultSwitched off
PrerequisiteThe app API is switched on. Public access is not required. Otherwise the app cannot be switched on: the card says “Requires API.”, and the side panel shows the section Requirement (App-Store).
Without Public accessAn embed reads the offers with its public key. The call has to name the website it comes from, and that website has to belong to the key. A call with a copied key that does not say this, for example from a script, is refused.
Switched onOther websites show offers as an embed, with a public key. Season and offer have the tab Embed (Embeds). The app shows the section Public keys.
Switch offConfirmation prompt: “Building blocks on other websites will show nothing. Switch off?” Switched off, the app shows “Building blocks show nothing, and “Embed” is hidden.” The keys stay saved.

Data protection

RowContent
Where toLocal
Data category— (no transfer)
Category of data subjects—
In additionContent
TransferNone to third parties. The embedding website loads the offers from fepli.

Public keys

A public key is part of the code of an embed and determines on which websites the embed runs (Embeds). The section is visible only while the app is switched on.

The section Public keys with an opened row.

ElementContent
Create a keyOpens a dialog with the fields Name (“only for you”) and Allowed websites (“comma-separated, subdomains included”), then Create. Without a website the dialog reports: “Name at least one website the key works on.” Message: “Key “{name}” created.”
Name · keyName and key. The key is public and shown in full; Copy the key copies it.
Allowed websitesThe websites on which the key is valid. On every other website, an embed with this key shows nothing.
Last usedDate and time of the last request that fepli has seen, or “never”. fepli updates the entry at most once per hour.
EditOpens the row: “Created on {date}”; every website with a cross for removing it; Add a website with Add; Revoke. The last website stays: “A key needs at least one website. To stop it everywhere, revoke it.” Close closes the row.
OperationEffect
Adding or removing a websiteApplies immediately, without Save. An address is saved as a domain; protocol and path are dropped.
RevokeOpens the dialog “Revoke the key “{name}”?”: “Embeds with this key show nothing afterwards.” Revoke deletes the key, Cancel closes the dialog. Message: “Key “{name}” revoked.”
No key“No key yet. Without a key, embeds show nothing.”