API · fepli manual

Through the app API, other websites and programs fetch offers and seasons through an interface.

Location: Settings > App-Store > card API. Visible to: super admins.

Group: API & embedding, included. Provider: none. The interface belongs to fepli.

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

What the app does

In the section What it does
“Hands offers and seasons to other systems through the interface.”
“With a token they act with the permissions of an account or service account.”
“Without a token there is only what the website shows too – while “Public access” is on.”

In the section How to use it
“Other systems call the endpoint named below.”
“Every account creates a token for itself, in its account under “API tokens”. You manage service accounts through the link below.”

Card in the catalogue: “Other websites and programs fetch your offers through an interface.”

Feature	Content
Access	No credentials
Default	Switched on
Endpoint	Address of the interface. Without an API domain of its own, it lies under the admin panel.
Public access	Reading without a token. Default: on. Off: every call must identify itself. Embeds of the app Embed in a website with a public key are exempt (Embed in a website). Save applies the change.
Manage service accounts	Leads to Settings > Integrations (Service accounts).
Switched on	The interface answers. Calls with a token act with the permissions of the account or service account.
Switch off	Confirmation prompt: “The endpoint will answer 404 – for everyone, including calls with a token. Switch off?” Switched off, the app shows “The endpoint answers 404.” Embeds then show nothing.

The app shows itself in the App-Store itself: switched on, the app contains the switch, the endpoint and the way to the service accounts.

App-Store/API

API & embedding

API

fepli

Switched on.

Settings

Public accessOn: readable without a token where it is public anyway. Off: token required – or a building block with a public key.

What it does

Data protection

Endpoint

https://beispiel.fepli.eu/api

Without an API domain: under /api at the admin panel.

Manage service accounts

Switch offCancelSave

The app API, switched on; What it does and Data protection are hinted at.

Element	Content
Notice	“Switched on.” Switched off: “Switched off.” with “The endpoint answers 404.”
Public access	Switch under Settings: “On: readable without a token where it is public anyway. Off: token required – or a building block with a public key.”
Endpoint	Address of the interface. Below it “Without an API domain: under /api at the admin panel.” or “The tenant's own domain.”
Manage service accounts	Leads to the service accounts.
Switch off	Shuts the interface down after a confirmation prompt.
Save	Applies the switch Public access.

In addition	Content
Transfer	None to third parties. Whoever calls the interface receives what their permissions allow.

The interface is described by the fepli developers.