Über expservices schreiben
Diese Seite richtet sich an App-Entwickler, deren App Inhalte auf eine Weise ändert, die die REST-API nicht bietet, vor
allem das Aktualisieren eines vorhandenen Elements. Die Knotendienste sind in
extension/expservices/classes/content/expnodeservices.php deklariert; die Regeln für Schreibzugriffe stehen in der
expservices-Referenz.
Inhalt
- Regeln für jeden Schreibzugriff
- Anlegen
- Aktualisieren
- Entfernen
- Felder, die sich nicht schreiben lassen
- Nach einem Schreibzugriff
Regeln für jeden Schreibzugriff
- Ein Schreibzugriff braucht
POST; seine Argumente sind Formularfelder im Inhalt, außer den IDs, die der Dienst in der URL entgegennimmt. - Mit einem expservices-Token (
BearerundX-Exp-Token) ist kein Formular-Token nötig. Mit einem Sitzungscookie holen Sie das Formular-Token vonexpsession::tokenund senden es als Feldezxform_tokenund als HeaderX-CSRF-Token. - Der Dienst prüft seine Richtlinie als aufrufender Benutzer. Eine fehlende Richtlinie antwortet mit
403im Umschlag. - Jeder erfolgreiche Schreibzugriff schreibt das Ereignis
service.<domain>.<method>ins Prüfprotokoll.
Anlegen
curl -s -H "Authorization: Bearer $EXPSERVICES_TOKEN" -H "X-Exp-Token: $EXPSERVICES_TOKEN" \
--data-urlencode 'class=article' \
--data-urlencode 'attributes={"title":"Report from the field","intro":"<p>Short text</p>"}' \
--data-urlencode 'language=eng-US' \
'https://example.com/ezjscore/call/expnode::create::<parent node id>?ContentType=json'expnode::create braucht content/create und veröffentlicht sofort. POST-Felder: class, attributes (eine JSON-Map
von Bezeichner zu Zeichenkette), language und optional remote_id. Der Dienst lehnt eine Klasse ab, die der Benutzer
unterhalb dieses Elternknotens nicht anlegen darf (403), prüft die Pflichtfelder der Klasse und antwortet mit 409,
wenn die remote_id bereits vergeben ist. Eine eigene remote_id (zum Beispiel eine auf dem Gerät erzeugte UUID)
erlaubt der App daher sichere Wiederholungen: Ein zweiter Versuch antwortet mit 409, statt das Element doppelt
anzulegen (Knoten-IDs, Remote-IDs und Deep Links). Die
Feldbezeichner im Beispiel sind Platzhalter; verwenden Sie die Ihrer Klasse.
Aktualisieren
curl -s -H "Authorization: Bearer $EXPSERVICES_TOKEN" -H "X-Exp-Token: $EXPSERVICES_TOKEN" \
--data-urlencode 'attributes={"title":"Corrected title"}' --data-urlencode 'language=eng-US' \
'https://example.com/ezjscore/call/expnode::update::<node id>?ContentType=json'expnode::update braucht content/edit, ändert die Attribute, die Sie senden, und veröffentlicht eine neue Version.
Felder, die Sie nicht senden, behalten ihre Werte. Kleinere Änderungen haben eigene Dienste: expnode::rename (POST
name), expnode::setPriority, expnode::hide, expnode::reveal.
Entfernen
curl -s -H "Authorization: Bearer $EXPSERVICES_TOKEN" -H "X-Exp-Token: $EXPSERVICES_TOKEN" \
-X POST 'https://example.com/ezjscore/call/expnode::remove::<node id>?ContentType=json'expnode::remove braucht content/remove und entfernt einen Knoten samt seinem Teilbaum. Das POST-Feld
move_to_trash ist standardmäßig 1, die Inhalte landen also im Papierkorb, aus dem ein Redakteur sie wiederherstellen
kann. Große Entfernungen können an einen Inhaltsjob übergeben werden und antworten dann mit dem Job statt mit
{removed}.
Felder, die sich nicht schreiben lassen
Die Knotendienste schreiben Felder der Datentypen ezimage, ezbinaryfile, ezmedia, ezuser, ezpassword und
ezflowblock nie entfernt: Ihr Zeichenkettenimport liest einen lokalen Pfad oder eine URL, oder sie enthalten
Zugangsdaten (expContentBase::$deniedInputTypes). Eine App kann über diese Dienste daher keine Fotos oder Dateien
anhängen (Dateien und Uploads).
Nach einem Schreibzugriff
- Lesen Sie das Element erneut (über die Knoten-ID, mit der REST-API), um anzuzeigen, was veröffentlicht wurde; Workflows auf dem Server können es verändert haben.
- Machen Sie den Cache der App für das Element und für die Liste seines Elternknotens ungültig (Caching in der App).
- Ist ein Schreibzugriff in eine Zeitüberschreitung gelaufen, suchen Sie das Element über seine
remote_id(expnode::getByRemoteId), bevor Sie es erneut versuchen.
Verwandte Seiten
- expservices aus einer App aufrufen
- Inhalte anlegen und entfernen
- Berechtigungen für App-Benutzer
- Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.
Werden Sie Exponential-Partner
Partner teilen ihre Informationen, stellen Mittel bereit, geben Beiträge zurück und entwickeln die Produkte mit uns, und so wächst Exponential. Eine Partner-Website und ein Dashboard sind für Mitte 2027 geplant: Werden Sie noch heute Partner, damit wir schneller wachsen und neue Funktionen früher liefern.