HandbuchReferenzApp-StoreAdmins
API
Über die App API rufen andere Websites und Programme Angebote und Saisons über eine Schnittstelle ab.
Ort: Einstellungen > App-Store > Karte API. Sichtbar für: Super-Admins.
Gruppe: API & Einbinden, inklusive. Anbieter: keiner. Die Schnittstelle gehört zu fepli.
Katalog, Zustände und Aufbau einer App beschreibt App-Store.
Was die App tut
| Im Abschnitt Was es tut |
|---|
| „Gibt anderen Systemen Angebote und Saisons über die Schnittstelle heraus.“ |
| „Mit einem Token arbeiten sie mit den Rechten eines Kontos oder Service-Accounts.“ |
| „Ohne Token gibt es nur, was auch auf der Website steht – solange „Öffentlicher Zugriff“ an ist.“ |
| Im Abschnitt Wie Sie es nutzen |
|---|
| „Andere Systeme rufen den Endpunkt auf, der unten steht.“ |
| „Ein Token legt jedes Konto für sich an, in seinem Konto unter „API-Tokens“. Service-Accounts verwalten Sie über den Link unten.“ |
Karte im Katalog: „Andere Websites und Programme rufen Ihre Angebote über eine Schnittstelle ab.“
Verhalten
| Merkmal | Inhalt |
|---|---|
| Zugang | Keine Zugangsdaten |
| Standard | Eingeschaltet |
| Endpunkt | Adresse der Schnittstelle. Sie liegt ohne eigene API-Domain unter dem Admin-Panel. |
| Öffentlicher Zugriff | Lesen ohne Token. Standard: an. Aus: Jeder Aufruf muss sich ausweisen. Ausgenommen sind Bausteine der App Website einbinden mit öffentlichem Schlüssel (Website einbinden). Speichern übernimmt die Änderung. |
| Service-Accounts verwalten | Führt zu Einstellungen > Integrationen (Service-Accounts). |
| Eingeschaltet | Die Schnittstelle antwortet. Aufrufe mit Token arbeiten mit den Rechten des Kontos oder Service-Accounts. |
| Ausschalten | Rückfrage: „Der Endpunkt antwortet danach mit 404 – für alle, auch für Aufrufe mit Token. Ausschalten?“ Ausgeschaltet zeigt die App „Der Endpunkt antwortet mit 404.“ Bausteine zeigen dann nichts. |
In fepli
Die App zeigt sich im App-Store selbst: Eingeschaltet stehen in der App der Schalter, der Endpunkt und der Weg zu den Service-Accounts.
App-Store/API
API & Einbinden
API
fepli
Eingeschaltet.
Einstellungen
Öffentlicher ZugriffAn: Ohne Token lesbar, was auch öffentlich ist. Aus: nur mit Token – oder als Baustein mit öffentlichem Schlüssel.
Was es tut
Datenschutz
Endpunkt
https://beispiel.fepli.eu/api
Ohne eigene API-Domain: unter /api beim Admin-Panel.
Service-Accounts verwalten
AusschaltenAbbrechenSpeichern
Die eingeschaltete App API; Was es tut und Datenschutz sind angedeutet.
| Element | Inhalt |
|---|---|
| Hinweis | „Eingeschaltet.“ Ausgeschaltet: „Ausgeschaltet.“ mit „Der Endpunkt antwortet mit 404.“ |
| Öffentlicher Zugriff | Schalter unter Einstellungen: „An: Ohne Token lesbar, was auch öffentlich ist. Aus: nur mit Token – oder als Baustein mit öffentlichem Schlüssel.“ |
| Endpunkt | Adresse der Schnittstelle. Darunter „Ohne eigene API-Domain: unter /api beim Admin-Panel.“ oder „Eigene Domain des Mandanten.“ |
| Service-Accounts verwalten | Führt zu den Service-Accounts. |
| Ausschalten | Schaltet die Schnittstelle nach einer Rückfrage ab. |
| Speichern | Übernimmt den Schalter Öffentlicher Zugriff. |
Datenschutz
| Zeile | Inhalt |
|---|---|
| Wohin | Lokal |
| Datenkategorie | — (keine Übertragung) |
| Betroffenenkategorie | — |
| Dazu | Inhalt |
|---|---|
| Übertragung | Keine an Dritte. Wer die Schnittstelle abruft, erhält, was seine Rechte erlauben. |
Die Schnittstelle beschreiben die fepli developers.