© 2026 phis.dev. Alle Rechte vorbehalten.
Brand logo
phis.dev
  • Startseite
  • Dokumentation
Ein Paar Klammern um einen Pfeil
Quelle

Die Server-API

Die Kommunikationswege zwischen einer Website und einem Agenten: Was jeder von ihnen übermittelt, worauf er antwortet und wer Anfragen stellen darf.
Auf dieser Seite
Inhaltsverzeichnis
/api/operator
/api/setup
/api/site
/api/v1/addons
/api/v1/admin
/api/v1/auth
/api/v1/email
/api/v1/entries
/api/v1/forms
/api/v1/groups
/api/v1/hooks
/api/v1/locales
/api/v1/media
/api/v1/notifications
/api/v1/site
/api/v1/tr
phis.dev
Schnellzugriff
AGB
Kontakt

HTTP-API-Referenz

Jeder Routen-Handler von phis, abgeleitet aus dem Code. Access bezeichnet, was der Handler überprüft, bevor er antwortet: internal token ist das Site-Token (x-phis-token) mit internem Geltungsbereich, API token akzeptiert ein öffentliches oder internes Token, und session ist die Site-Sitzung des Besuchers mit der Zugriffsrichtlinie, die der Guard freigibt (siehe AUTHORIZATION.md). Eine Route ohne Zugriffseintrag führt eigene Prüfungen durch oder gar keine; lesen Sie den Quellcode. Die Formate von Anfragen und Antworten sind nicht aufgeführt; der Quellcode ist für jede Route verlinkt.
161 Strecken.

Inhaltsverzeichnis

  • /api/operator (5)
  • /api/setup (2)
  • /api/site (84)
  • /api/v1/addons (2)
  • /api/v1/admin (1)
  • /api/v1/auth (29)
  • /api/v1/email (1)
  • /api/v1/entries (2)
  • /api/v1/forms (8)
  • /api/v1/groups (3)
  • /api/v1/hooks (1)
  • /api/v1/locales (1)
  • /api/v1/media (2)
  • /api/v1/notifications (2)
  • /api/v1/site (17)
  • /api/v1/tr (1)

/api/operator

Authentifizierung an der Bedienerkonsole.
VerfahrenAnschriftZugangBeschreibung
GET/api/operator/auth/csrf--Das CSRF-Token, das das Anmeldeformular für Administratoren zurücksendet. Da die Administratorkonsole von diesem Server bereitgestellt wird, erfolgt die Abfrage hier und nicht über die Schnittstelle /api/auth einer Website, die den Core nur mit dem Token der jeweiligen Website erreicht.
BEITRAG/api/operator/auth/loginSetup-Modus (`bootstrap.enabled`); CSRF-Token
BEITRAG/api/operator/auth/logoutBedienersitzung
BEITRAG/api/operator/auth/refreshBedienersitzung
GET/api/operator/overview/metricsBedienersitzung; Einrichtungsmodus (bootstrap.enabled)

/api/setup

VerfahrenAnschriftZugangBeschreibung
BEITRAG/api/setup/platform-super-users/clearsetup mode (bootstrap.enabled)
BEITRAG/api/setup/runtime-checksetup mode (bootstrap.enabled)

/api/site

Website-Verwaltung, CMS, Medien und Support-API. Der Proxy /api/site einer Website leitet die Sitzung des Besuchers weiter.
VerfahrenAnschriftZugangBeschreibung
GET/api/site/account/avatarSitzung, authenticated (requireSiteAuthenticatedApiContext)
PUT/api/site/account/avatarSitzung, authenticated (requireSiteAuthenticatedApiContext)
LÖSCHEN/api/site/account/avatarSitzung, authenticated (requireSiteAuthenticatedApiContext)
GET/api/site/addon-rolesSitzung, authenticated (requireSiteAuthenticatedApiContext)Was der Aufrufende gewähren kann und gegebenenfalls, was eine Person bereits besitzt.
BEITRAG/api/site/addon-rolesSitzung, authenticated (requireSiteAuthenticatedApiContext)
LÖSCHEN/api/site/addon-rolesSitzung, authenticated (requireSiteAuthenticatedApiContext)
GET/api/site/admin/localesSitzung, site-admin (requireSiteAdminOnlyApiContext)
PATCH/api/site/admin/localesSitzung, site-admin (requireSiteAdminOnlyApiContext)
LÖSCHEN/api/site/admin/localesSitzung, site-admin (requireSiteAdminOnlyApiContext)
GET/api/site/admin/logsSitzung, developer-tools (requireSiteDeveloperApiContext)
GET/api/site/admin/logs/detailSitzung, developer-tools (requireSiteDeveloperApiContext)
GET/api/site/admin/mediaSitzung, developer-tools (requireSiteDeveloperApiContext)
PATCH/api/site/admin/mediaSitzung, developer-tools (requireSiteDeveloperApiContext)
GET/api/site/admin/settingsSitzung, site-admin (requireSiteAdminOnlyApiContext)
PATCH/api/site/admin/settingsSitzung, site-admin (requireSiteAdminOnlyApiContext)
GET/api/site/admin/usersSitzung, site-admin (requireSiteAdminOnlyApiContext)
BEITRAG/api/site/admin/usersSitzung, site-admin (requireSiteAdminOnlyApiContext)
PUT/api/site/admin/usersSitzung, site-admin (requireSiteAdminOnlyApiContext)
PATCH/api/site/admin/usersSitzung, site-admin (requireSiteAdminOnlyApiContext)
LÖSCHEN/api/site/admin/usersSitzung, site-admin (requireSiteAdminOnlyApiContext)
BEITRAG/api/site/cms/areaSitzung, structure-authoring (requireSiteBuilderApiContext)
LÖSCHEN/api/site/cms/areaSitzung, structure-authoring (requireSiteBuilderApiContext)
GET/api/site/cms/area/draftSitzung, roles (requireSiteReviewApiContext)
BEITRAG/api/site/cms/area/modulesSitzung, structure-authoring (requireSiteBuilderApiContext)
LÖSCHEN/api/site/cms/area/modulesSitzung, structure-authoring (requireSiteBuilderApiContext)
GET/api/site/cms/area/modules/draftSitzung, roles (requireSiteReviewApiContext)
BEITRAG/api/site/cms/area/modules/publishSitzung, publishing (requireSitePublisherApiContext)
LÖSCHEN/api/site/cms/area/overrideSitzung, publishing (requireSitePublisherApiContext)
BEITRAG/api/site/cms/area/publishSitzung, publishing (requireSitePublisherApiContext)
BEITRAG/api/site/cms/area/structuresSitzung, roles (requireSiteReviewApiContext)
GET/api/site/cms/module-usageSitzung, structure-authoring (requireSiteBuilderApiContext)Welche Informationen ein Modul derzeit aus den veröffentlichten Seiten dieser Website bezieht.
GET/api/site/cms/navigationSitzung, roles (requireSiteReviewApiContext)
BEITRAG/api/site/cms/navigationSitzung, structure-authoring (requireSiteBuilderApiContext)
LÖSCHEN/api/site/cms/navigationSitzung, structure-authoring (requireSiteBuilderApiContext)
GET/api/site/cms/navigation/draftSitzung, roles (requireSiteReviewApiContext)
BEITRAG/api/site/cms/navigation/publishSitzung, publishing (requireSitePublisherApiContext)
BEITRAG/api/site/cms/pageSitzung, structure-authoring (requireSiteBuilderApiContext)
LÖSCHEN/api/site/cms/pageSitzung, structure-authoring (requireSiteBuilderApiContext)
BEITRAG/api/site/cms/page/createSitzung, structure-authoring (requireSiteBuilderApiContext)
GET/api/site/cms/page/draftSitzung, roles (requireSiteReviewApiContext)
LÖSCHEN/api/site/cms/page/overrideSitzung, publishing (requireSitePublisherApiContext)
BEITRAG/api/site/cms/page/publishSitzung, publishing (requireSitePublisherApiContext)
GET/api/site/cms/pagesSitzung, roles (requireSiteReviewApiContext)
BEITRAG/api/site/cms/pages/{scopeId}/pathSitzung, structure-authoring (requireSiteBuilderApiContext)
GET/api/site/cms/revisionsSitzung, roles (requireSiteReviewApiContext)
LÖSCHEN/api/site/cms/revisionsSitzung, structure-authoring (requireSiteBuilderApiContext)
BEITRAG/api/site/cms/revisions/restoreSitzung, structure-authoring (requireSiteBuilderApiContext)
GET/api/site/cms/themeSitzung, roles (requireSiteReviewApiContext)
BEITRAG/api/site/cms/themeSitzung, structure-authoring (requireSiteBuilderApiContext)
LÖSCHEN/api/site/cms/themeSitzung, structure-authoring (requireSiteBuilderApiContext)
GET/api/site/cms/theme/draftSitzung, roles (requireSiteReviewApiContext)
BEITRAG/api/site/cms/theme/publishSitzung, publishing (requireSitePublisherApiContext)
GET/api/site/editor/contentSitzung, roles (requireSiteReviewApiContext)
PUT/api/site/editor/contentSitzung, roles (requireSiteReviewApiContext)
BEITRAG/api/site/editor/content/publishSitzung, publishing (requireSitePublisherApiContext)
LÖSCHEN/api/site/editor/content/publishSitzung, publishing (requireSitePublisherApiContext)
BEITRAG/api/site/editor/content/submitSitzung, roles (requireSiteReviewApiContext)
LÖSCHEN/api/site/editor/content/submitSitzung, roles (requireSiteReviewApiContext)
GET/api/site/editor/entries/{kind}Sitzung, content-editing (requireSiteAuthorApiContext)
PUT/api/site/editor/entries/{kind}Sitzung, content-editing (requireSiteAuthorApiContext)
LÖSCHEN/api/site/editor/entries/{kind}Sitzung, content-editing (requireSiteAuthorApiContext)
GET/api/site/editor/entries/{kind}/categoriesSitzung, content-editing (requireSiteAuthorApiContext)
PUT/api/site/editor/entries/{kind}/categoriessession, publishing (requireSitePublisherApiContext); session, content-editing (requireSiteAuthorApiContext)
LÖSCHEN/api/site/editor/entries/{kind}/categoriessession, publishing (requireSitePublisherApiContext); session, content-editing (requireSiteAuthorApiContext)
GET/api/site/editor/entries/{kind}/curationSitzung, content-editing (requireSiteAuthorApiContext)
PATCH/api/site/editor/entries/{kind}/curationSitzung, publishing (requireSitePublisherApiContext)
BEITRAG/api/site/editor/entries/{kind}/publishSitzung, publishing (requireSitePublisherApiContext)
LÖSCHEN/api/site/editor/entries/{kind}/publishSitzung, publishing (requireSitePublisherApiContext)
BEITRAG/api/site/editor/entries/{kind}/submitSitzung, content-editing (requireSiteAuthorApiContext)
LÖSCHEN/api/site/editor/entries/{kind}/submitSitzung, content-editing (requireSiteAuthorApiContext)
BEITRAG/api/site/editor/page-metaSitzung, content-editing (requireSiteAuthorApiContext)
GET/api/site/editor/releasesSitzung, roles (requireSiteReviewApiContext)
GET/api/site/editor/translationsSitzung, content-editing (requireSiteAuthorApiContext)
PATCH/api/site/editor/translationsSitzung, publishing (requireSitePublisherApiContext)
LÖSCHEN/api/site/editor/translationssession, roles (requireSiteReviewApiContext); session, publishing (requireSitePublisherApiContext)
GET/api/site/groupsSitzung (requireSiteGroupMemberApiContext); Sitzung, authenticated (requireSiteAuthenticatedApiContext)
BEITRAG/api/site/groupsSitzung, developer-tools (requireSiteDeveloperApiContext)Das Anlegen einer Gruppe erfolgt in der Website-Administration: Eine Gruppe ist eine Berechtigungseinheit, auf die sich die Seiten, die Navigation und die Assets beziehen; daher darf die Zugehörigkeit zu einer Gruppe niemals die Befugnis zum Anlegen weiterer Gruppen gewähren.
PATCH/api/site/groupsSitzung (requireSiteGroupManagerApiContext)
PUT/api/site/groupsSitzung (requireSiteGroupManagerApiContext)
LÖSCHEN/api/site/groupsSitzung (requireSiteGroupManagerApiContext)
GET/api/site/groups/candidatesSitzung (requireSiteGroupManagerAnywhereApiContext)
GET/api/site/mediaSitzung (requireMediaManagementSiteContext)
GET/api/site/media/{id}Sitzung (requireMediaAssetContext)
PATCH/api/site/media/{id}Sitzung (requireMediaAssetContext)
LÖSCHEN/api/site/media/{id}Sitzung (requireMediaAssetContext)
GET/api/site/media/{id}/contentRichtlinie zur Bereitstellung von Assets (öffentliche Assets erfordern keine Sitzung)Die Bytes eines Assets, entweder vollständig oder teilweise.
KOPF/api/site/media/{id}/contentRichtlinie zur Bereitstellung von Assets (öffentliche Assets erfordern keine Sitzung)Die Bytes eines Assets, entweder vollständig oder teilweise.
PUT/api/site/media/{id}/ownerSitzung (requireMediaAssetContext)Ein Vermögenswert wird übergeben.
GET/api/site/media/{id}/subsets/{subsetKey}Richtlinie zur Bereitstellung von Assets (öffentliche Assets erfordern keine Sitzung)
KOPF/api/site/media/{id}/subsets/{subsetKey}Richtlinie zur Bereitstellung von Assets (öffentliche Assets erfordern keine Sitzung)
GET/api/site/media/{id}/variants/{variantKey}Richtlinie zur Bereitstellung von Assets (öffentliche Assets erfordern keine Sitzung)
KOPF/api/site/media/{id}/variants/{variantKey}Richtlinie zur Bereitstellung von Assets (öffentliche Assets erfordern keine Sitzung)
GET/api/site/media/foldersSitzung (requireMediaManagementSiteContext)
BEITRAG/api/site/media/foldersSitzung (requireMediaManagementSiteContext)
GET/api/site/media/folders/{id}Sitzung (requireMediaManagementSiteContext)
PATCH/api/site/media/folders/{id}Sitzung (requireMediaManagementSiteContext)
LÖSCHEN/api/site/media/folders/{id}Sitzung (requireMediaManagementSiteContext)
PATCH/api/site/media/spaces/{address}Sitzung, authenticated (requireSiteAuthenticatedApiContext)
PUT/api/site/media/uploads/{token}Website-Sitzung, im Handler überprüft; Sitzung (requireMediaSpaceWriteContext)
BEITRAG/api/site/media/uploads/{token}/finalizeSitzung (requireMediaSpaceWriteContext)
BEITRAG/api/site/media/uploads/{token}/reportWebsite-Sitzung, im Handler überprüft; Sitzung (requireMediaSpaceWriteContext)
BEITRAG/api/site/media/uploads/initSitzung (requireMediaSpaceWriteContext)
GET/api/site/support/forwardSitzung, support (requireSiteSupportApiContext)Wo die Tickets dieser Website derzeit weitergeleitet werden können.
BEITRAG/api/site/support/forwardSitzung, support (requireSiteSupportApiContext)Weist die Arbeit an einem Ticket einem Ziel zu: { ticketId, target, title? }.
BEITRAG/api/site/support/linkSitzung, support (requireSiteSupportApiContext)Verknüpft einen Datensatz, der bereits an anderer Stelle vorhanden ist, mit einem Ticket: { ticketId, reference }.
GET/api/site/support/queuesSitzung, support (requireSiteSupportApiContext)Die Support-Warteschlangen der Website.
BEITRAG/api/site/support/queuesSitzung, developer-tools (requireSiteDeveloperApiContext)Fügt eine Warteschlange hinzu.
PATCH/api/site/support/queues/{queueId}Sitzung, developer-tools (requireSiteDeveloperApiContext)Bearbeitet eine Warteschlange: deren Namen, die Gruppe, an die sie weitergeleitet wird, ihre Reihenfolge und ob sie deaktiviert ist.
BEITRAG/api/site/support/requestSitzung, authenticated (requireSiteAuthenticatedApiContext)Der Zugang für die fragende Person.
GET/api/site/support/request/typesSitzung, authenticated (requireSiteAuthenticatedApiContext)Was eine Person, die kein Mitarbeiter ist, anfragen darf.
GET/api/site/support/ticket-typesSitzung, support (requireSiteSupportApiContext)Die Ticketarten der Website.
PATCH/api/site/support/ticket-typesSitzung, developer-tools (requireSiteDeveloperApiContext)Legt fest, was im gesamten Katalog gilt: requesterWindowDays, das Zeitfenster, auf das alle Typen zurückgreifen, sofern sie kein eigenes haben. Mit dem Wert 0 wird das automatische Schließen für alle Typen gleichzeitig deaktiviert.
BEITRAG/api/site/support/ticket-typesSitzung, developer-tools (requireSiteDeveloperApiContext)Fügt einen Ticket-Typ hinzu.
PATCH/api/site/support/ticket-types/{typeId}Sitzung, developer-tools (requireSiteDeveloperApiContext)Hier wird eine Ticketart bearbeitet, und hier legt eine Website fest, wer diese beantragen darf.
GET/api/site/support/ticketsSitzung, support (requireSiteSupportApiContext)
BEITRAG/api/site/support/ticketsSitzung, support (requireSiteSupportApiContext)
GET/api/site/support/tickets/{ticketId}Sitzung, support (requireSiteSupportApiContext)
PATCH/api/site/support/tickets/{ticketId}Sitzung, support (requireSiteSupportApiContext)
BEITRAG/api/site/support/tickets/{ticketId}/assignmentSitzung, support (requireSiteSupportApiContext)
GET/api/site/support/tickets/{ticketId}/eventsSitzung, support (requireSiteSupportApiContext)Was mit einem Ticket geschah, beginnend mit dem ältesten Eintrag: eröffnet, in der Rangliste verschoben, angenommen, zwischen Warteschlangen verschoben, weitergeleitet, geschlossen. Nur für Support-Mitarbeiter – der Verlauf enthält Angaben zu Warteschlangen, Verantwortlichen und dem Ort, an den die Arbeit weitergeleitet wurde; diese Informationen werden dem Anfragenden nicht mitgeteilt.
BEITRAG/api/site/support/tickets/{ticketId}/tasksSitzung, support (requireSiteSupportApiContext)
PATCH/api/site/support/tickets/{ticketId}/tasks/{taskId}Sitzung, support (requireSiteSupportApiContext)
LÖSCHEN/api/site/support/tickets/{ticketId}/tasks/{taskId}Sitzung, support (requireSiteSupportApiContext)
GET/api/site/threadsSitzung, authenticated (requireSiteAuthenticatedApiContext)
BEITRAG/api/site/threadsSitzung, authenticated (requireSiteAuthenticatedApiContext)
GET/api/site/threads/{threadId}Sitzung, authenticated (requireSiteAuthenticatedApiContext)
PATCH/api/site/threads/{threadId}Sitzung, authenticated (requireSiteAuthenticatedApiContext)Archivierung und Wiedereröffnung. Da der Status in einer Zeile erfasst wird, gilt dieser Thread-Schluss für alle – und somit nur für den Eröffner, einen Mitarbeiter oder einen Gruppenleiter dieser Gruppe (die Entscheidung erfolgt über setThreadStatus).
BEITRAG/api/site/threads/{threadId}/messagesSitzung, authenticated (requireSiteAuthenticatedApiContext)In eine Konversation schreiben, adressiert über den Pfad.
GET/api/site/threads/{threadId}/messages/{messageId}/assets/{assetId}Sitzung, authenticated (requireSiteAuthenticatedApiContext)Die Byte eines Anhangs, auf den über die Nachricht zugegriffen wird, die ihn benennt.
BEITRAG/api/site/threads/{threadId}/messages/{messageId}/translateSitzung, authenticated (requireSiteAuthenticatedApiContext)Eine Nachricht, in einer anderen Sprache gelesen, und nichts blieb davon erhalten.
BEITRAG/api/site/threads/{threadId}/participantsSitzung, authenticated (requireSiteAuthenticatedApiContext)Fügt Personen oder Gruppen hinzu. Es werden niemals Teilnehmer entfernt: Das Verlassen der Gruppe ist eine Entscheidung des Teilnehmers selbst und nicht das Ergebnis einer Bearbeitung durch eine andere Person.
BEITRAG/api/site/threads/{threadId}/readSitzung, authenticated (requireSiteAuthenticatedApiContext)
GET/api/site/threads/candidatesSitzung, authenticated (requireSiteAuthenticatedApiContext)An wen sich diese Person richtet und welche Arten von Themen diese Website bietet.
BEITRAG/api/site/threads/messagesSitzung, authenticated (requireSiteAuthenticatedApiContext)Dies entspricht dem Aufruf von /api/site/threads/{threadId}/messages, wobei der Gesprächsverlauf im Hauptteil enthalten ist.
GET/api/site/translationSitzung, authenticated (requireSiteAuthenticatedApiContext)Ob sich diese Installation auf diese Website übertragen lässt und in welche Form.
BEITRAG/api/site/translation/detectSitzung, structure-authoring (requireSiteBuilderApiContext)
GET/api/site/user-stateSitzung, authenticated (requireSiteAuthenticatedApiContext)Alle Informationen, die die aktiven Module dieser Website über die fragende Person gespeichert haben.
PATCH/api/site/user-stateSitzung, authenticated (requireSiteAuthenticatedApiContext)Ein Schlüssel wurde geschrieben, alle anderen Namespaces in der Zeile blieben unverändert.
LÖSCHEN/api/site/user-stateSitzung, authenticated (requireSiteAuthenticatedApiContext)Ein Schlüssel wurde entfernt, was nicht dasselbe ist wie das Schreiben eines falschen Werts.

/api/v1/addons

Bei der versionierten API ruft eine Website mit ihrem Token (x-phis-token) den Server ab und nutzt die darunter liegenden öffentlichen Endpunkte.
VerfahrenAnschriftZugangBeschreibung
LÖSCHEN/api/v1/addons/{scope}/{name}/{...path?}wird pro Route vom Add-on-Dispatcher festgelegt (SERVER_ADDONS.md)
GET/api/v1/addons/{scope}/{name}/{...path?}wird pro Route vom Add-on-Dispatcher festgelegt (SERVER_ADDONS.md)
PATCH/api/v1/addons/{scope}/{name}/{...path?}wird pro Route vom Add-on-Dispatcher festgelegt (SERVER_ADDONS.md)
BEITRAG/api/v1/addons/{scope}/{name}/{...path?}wird pro Route vom Add-on-Dispatcher festgelegt (SERVER_ADDONS.md)
PUT/api/v1/addons/{scope}/{name}/{...path?}wird pro Route vom Add-on-Dispatcher festgelegt (SERVER_ADDONS.md)
BEITRAG/api/v1/addons/jobsinternes TokenEin deklarierter Add-on-Auftrag wird gestartet.

/api/v1/admin

Bei der versionierten API ruft eine Website mit ihrem Token (x-phis-token) den Server ab und nutzt die darunter liegenden öffentlichen Endpunkte.
VerfahrenAnschriftZugangBeschreibung
GET/api/v1/admin/customers/registration-profileinternes Token

/api/v1/auth

Bei der versionierten API ruft eine Website mit ihrem Token (x-phis-token) den Server ab und nutzt die darunter liegenden öffentlichen Endpunkte.
VerfahrenAnschriftZugangBeschreibung
LÖSCHEN/api/v1/auth/account/factors/{factorId}CSRF-Token; Website-Sitzung, im Handler überprüft; internes Token
GET/api/v1/auth/account/securityWebsite-Sitzung, im Handler überprüft; internes Token
LÖSCHEN/api/v1/auth/account/sessions/{sessionId}CSRF-Token; Website-Sitzung, im Handler überprüft; internes Token
GET/api/v1/auth/admin/installationsSitzung (requireAuthAdminSectionReadContext)
BEITRAG/api/v1/auth/admin/installationsSitzung (requireAuthAdminSectionContext)
PATCH/api/v1/auth/admin/installationsCSRF-Token; Sitzung (requireAuthAdminSectionContext); Sitzung (requireAuthAdminSectionReadContext)Aktualisierung auf Sammlungsebene, die vom Deskriptor „Form relay“ verwendet wird (dessen vorgelagerter Pfad statisch ist): Der Installationsschlüssel wird im Hauptteil übertragen; die angewandte Logik entspricht der PATCH-Route mit URL-Adressierung.
PATCH/api/v1/auth/admin/installations/{installationKey}Sitzung (requireAuthAdminSectionContext)
LÖSCHEN/api/v1/auth/admin/installations/{installationKey}Sitzung (requireAuthAdminSectionContext)
BEITRAG/api/v1/auth/admin/installations/{installationKey}/testSitzung (requireAuthAdminSectionContext)
PATCH/api/v1/auth/admin/password-methodCSRF-Token; Sitzung (requireAuthAdminSectionContext); Sitzung (requireAuthAdminSectionReadContext)Endpunkt des flachen Abschnitts für die primäre Passwort-Anmeldemethode. Akzeptiert genau die Werte aus dem Einstellungsformular; die Darstellung der Methode wird unverändert übernommen.
PATCH/api/v1/auth/admin/policyCSRF-Token; Sitzung (requireAuthAdminSectionContext); Sitzung (requireAuthAdminSectionReadContext)Endpunkt des „Flat“-Abschnitts für die Registrierungs-/Verknüpfungsrichtlinie von „Auth Admin“. Akzeptiert genau die Werte aus dem Einstellungsformular; alle anderen Felder der Richtlinie werden unverändert übernommen.
PATCH/api/v1/auth/admin/totp-policyCSRF-Token; Sitzung (requireAuthAdminSectionContext); Sitzung (requireAuthAdminSectionReadContext)Endpunkt des Flat-Abschnitts für die Zwei-Faktor-Richtlinie (TOTP). Akzeptiert genau die Werte aus dem Einstellungsformular; die Rollen-Bitmaske, die Grace-Period-Löschung und die Kopplung von erforderlicher Richtlinie und Methode werden serverseitig abgeleitet.
GET/api/v1/auth/csrfinternes Token
BEITRAG/api/v1/auth/logoutinternes Token
GET/api/v1/auth/manifestinternes Token
GET/api/v1/auth/meinternes Token
BEITRAG/api/v1/auth/password/logininternes Token
BEITRAG/api/v1/auth/password/reset/confirminternes Token
BEITRAG/api/v1/auth/password/reset/requestinternes Token
BEITRAG/api/v1/auth/profile/email/requestinternes Token
PATCH/api/v1/auth/profile/localeinternes Token
PATCH/api/v1/auth/profile/nameinternes Token
PATCH/api/v1/auth/profile/newsletterinternes Token
PATCH/api/v1/auth/profile/passwordinternes Token
PATCH/api/v1/auth/profile/themeinternes Token
GET/api/v1/auth/providers/{provider}/callbackinternes Token
BEITRAG/api/v1/auth/providers/{provider}/startCSRF-Token; internes Token
BEITRAG/api/v1/auth/providers/link/confirmCSRF-Token; internes Token
GET/api/v1/auth/workflowWebsite-Sitzung, im Handler überprüft; internes Token
BEITRAG/api/v1/auth/workflow/totp/confirmCSRF-Token; Website-Sitzung, im Handler überprüft; internes Token
BEITRAG/api/v1/auth/workflow/totp/enrollCSRF-Token; Website-Sitzung, im Handler überprüft; internes Token
BEITRAG/api/v1/auth/workflow/verifyCSRF-Token; Website-Sitzung, im Handler überprüft; internes Token

/api/v1/email

Bei der versionierten API ruft eine Website mit ihrem Token (x-phis-token) den Server ab und nutzt die darunter liegenden öffentlichen Endpunkte.
VerfahrenAnschriftZugangBeschreibung
BEITRAG/api/v1/email/sendinternes Token

/api/v1/entries

Bei der versionierten API ruft eine Website mit ihrem Token (x-phis-token) den Server ab und nutzt die darunter liegenden öffentlichen Endpunkte.
VerfahrenAnschriftZugangBeschreibung
GET/api/v1/entries/{kind}API-Token (öffentlich oder intern)
GET/api/v1/entries/{kind}/{slug}API-Token (öffentlich oder intern)So viele Verwandte, wie auf einer Seite unter einem Eintrag angezeigt werden; bei einer größeren Anzahl wird eine eigene Liste-Seite angezeigt. */ const DEFAULT_RELATED_LIMIT = 3; const MAX_RELATED_LIMIT = 12;

/api/v1/forms

Bei der versionierten API ruft eine Website mit ihrem Token (x-phis-token) den Server ab und nutzt die darunter liegenden öffentlichen Endpunkte.
VerfahrenAnschriftZugangBeschreibung
BEITRAG/api/v1/forms/contactinternes Token
GET/api/v1/forms/guardinternes Token
BEITRAG/api/v1/forms/media-folderSitzung (requireSiteMediaApiContext)
BEITRAG/api/v1/forms/media-metadataSitzung (requireSiteMediaApiContext)
BEITRAG/api/v1/forms/registerinternes Token
BEITRAG/api/v1/forms/register/confirminternes Token
GET/api/v1/forms/register/confirm-previewinternes Token
GET/api/v1/forms/registryinternes Token

/api/v1/groups

Bei der versionierten API ruft eine Website mit ihrem Token (x-phis-token) den Server ab und nutzt die darunter liegenden öffentlichen Endpunkte.
VerfahrenAnschriftZugangBeschreibung
GET/api/v1/groupsSitzung, developer-tools (requireSiteDeveloperApiContext)
BEITRAG/api/v1/groupsSitzung, developer-tools (requireSiteDeveloperApiContext)
GET/api/v1/groups/{groupId}/membersSitzung (requireSiteGroupMemberApiContext)
PUT/api/v1/groups/{groupId}/members/{userId}Sitzung (requireSiteGroupManagerApiContext)
LÖSCHEN/api/v1/groups/{groupId}/members/{userId}Sitzung (requireSiteGroupManagerApiContext)

/api/v1/hooks

Bei der versionierten API ruft eine Website mit ihrem Token (x-phis-token) den Server ab und nutzt die darunter liegenden öffentlichen Endpunkte.
VerfahrenAnschriftZugangBeschreibung
LÖSCHEN/api/v1/hooks/{scope}/{name}/{...path?}wird pro Route vom Add-on-Dispatcher festgelegt (SERVER_ADDONS.md)
GET/api/v1/hooks/{scope}/{name}/{...path?}wird pro Route vom Add-on-Dispatcher festgelegt (SERVER_ADDONS.md)
PATCH/api/v1/hooks/{scope}/{name}/{...path?}wird pro Route vom Add-on-Dispatcher festgelegt (SERVER_ADDONS.md)
BEITRAG/api/v1/hooks/{scope}/{name}/{...path?}wird pro Route vom Add-on-Dispatcher festgelegt (SERVER_ADDONS.md)
PUT/api/v1/hooks/{scope}/{name}/{...path?}wird pro Route vom Add-on-Dispatcher festgelegt (SERVER_ADDONS.md)

/api/v1/locales

Bei der versionierten API ruft eine Website mit ihrem Token (x-phis-token) den Server ab und nutzt die darunter liegenden öffentlichen Endpunkte.
VerfahrenAnschriftZugangBeschreibung
GET/api/v1/localesAPI-Token (öffentlich oder intern)

/api/v1/media

Bei der versionierten API ruft eine Website mit ihrem Token (x-phis-token) den Server ab und nutzt die darunter liegenden öffentlichen Endpunkte.
VerfahrenAnschriftZugangBeschreibung
BEITRAG/api/v1/media/checksums/recomputeinternes TokenStellt Assets bereit, die zuvor gespeichert wurden, damit eine Duplikatserkennung anhand von Digests einen Vergleich durchführen kann.
BEITRAG/api/v1/media/storage-policies/reconcileinternes TokenSchreibt die Regeln jedes Speichers aus der Site-Registrierung: Wer darf dort schreiben und was ist zu bereinigen?

/api/v1/notifications

Bei der versionierten API ruft eine Website mit ihrem Token (x-phis-token) den Server ab und nutzt die darunter liegenden öffentlichen Endpunkte.
VerfahrenAnschriftZugangBeschreibung
BEITRAG/api/v1/notifications/draininternes TokenÜbermittlung der noch ausstehenden Beträge für den Einsatzplaner des Betreibers.
GET/api/v1/notifications/unsubscribeinternes TokenWas der Link ist, ohne etwas dagegen zu unternehmen, damit daraus eine Seite erstellt werden kann.
BEITRAG/api/v1/notifications/unsubscribeinternes Token

/api/v1/site

Bei der versionierten API ruft eine Website mit ihrem Token (x-phis-token) den Server ab und nutzt die darunter liegenden öffentlichen Endpunkte.
VerfahrenAnschriftZugangBeschreibung
GET/api/v1/siteinternes Token
GET/api/v1/site/areainternes Token; Sitzung (requireSiteCmsPreviewApiContext)
GET/api/v1/site/auth/installationsinternes TokenInterner Lesezugriff auf die Installationen des Website-Anbieters zur serverseitigen Zusammensetzung. Vertrauliche Daten verlassen den Speicher zu keinem Zeitpunkt; die Nutzdaten enthalten lediglich den Status „konfiguriert“ oder „fehlt“. Änderungen bleiben auf den durch eine Sitzung geschützten Endpunkten /api/v1/auth/admin/installations.
GET/api/v1/site/auth/settingsinternes TokenInterne Abfrage der Werte aus dem Bereich „Auth Admin“ für die serverseitige Zusammensetzung (die Seite „Admin-Authentifizierungseinstellungen“ lädt hier die Anfangswerte für ihr Formular). Enthält keine Provider-Installationen und keine Geheimnisse; Änderungen erfolgen ausschließlich über die durch die Sitzung geschützten Endpunkte des Bereichs.
GET/api/v1/site/capabilitiesinternes Token
GET/api/v1/site/contentinternes Token
GET/api/v1/site/localeWebsite-Sitzung, im Handler überprüft; internes Token
GET/api/v1/site/media/folder-imagesinternes TokenDie öffentlich zugänglichen Bilder eines Medienordners für eine Seite, auf der ein Ordner anstelle einzelner Assets angezeigt wird.
GET/api/v1/site/media/settingsinternes TokenInterner Lesezugriff auf die Medienkonfiguration der Website für die serverseitige Zusammenstellung (die Seite „Admin-Medieneinstellungen“ lädt hier die Anfangswerte ihres Formulars). Änderungen erfolgen weiterhin über die sitzungsgeschützte Route /api/site/admin/media; dieser Endpunkt ist mit einem internen Token schreibgeschützt.
GET/api/v1/site/navinternes Token; Sitzung (requireSiteCmsPreviewApiContext)
GET/api/v1/site/nav/folderinternes TokenWenn eine Ordneradresse eines Bereichs als Seitenverweis dient, soll die Website auf eine Anfrage, bei der keine Seite gefunden wurde, mit einem 307-Statuscode antworten. Dies gilt ausschließlich für den Fall eines falschen Pfads; bei einer Adresse, die ins Leere führt, wird ein 404-Statuscode zurückgegeben.
GET/api/v1/site/nav/scopesinternes Token
GET/api/v1/site/pageinternes Token; Sitzung (requireSiteCmsPreviewApiContext)
BEITRAG/api/v1/site/referencesinternes TokenMassenabfrage für die internen Referenzformulare, die in der Datei REFERENCES.md definiert sind.
GET/api/v1/site/settingsinternes TokenInterner Lesezugriff auf die Oberfläche der Admin-Einstellungen der Website für die serverseitige Komposition (die Seite „Allgemeine Admin-Einstellungen“ lädt hier die Anfangswerte ihres Formulars). Änderungen erfolgen weiterhin über die durch eine Sitzung geschützte Route /api/site/admin/settings; dieser Endpunkt ist mit einem internen Token schreibgeschützt.
GET/api/v1/site/statsinternes Token
GET/api/v1/site/themeinternes Token; Sitzung (requireSiteCmsPreviewApiContext)

/api/v1/tr

Bei der versionierten API ruft eine Website mit ihrem Token (x-phis-token) den Server ab und nutzt die darunter liegenden öffentlichen Endpunkte.
VerfahrenAnschriftZugangBeschreibung
GET/api/v1/trAPI-Token (öffentlich oder intern)
BEITRAG/api/v1/trAPI-Token (öffentlich oder intern)