REST API verwenden

Prosodia VGW OS erweitert die WordPress-REST-API um Zählmarken.

Bevor auf die eigentliche API zugegriffen werden kann, muss ein REST-API-Schlüssel unter Prosodia VGW OS → Einstellungen → REST API → REST-API-Schlüssel durch Klicken auf „neu generieren“ erstellt werden.

REST-API-Schlüssel erzeugen
Einen REST-API-Schlüssel erzeugen.

Der generierte Schlüssel wird für die API-Aufrufe benötigt. Die Abfrage-URLs sind:

  • http://<wordpress-domain>/wp-json/wpvgw/v1 – Basis-URL
  • http://<wordpress-domain>/wp-json/wpvgw/v1/markers – Zählmarken-Liste abrufen
  • http://<wordpress-domain>/wp-json/wpvgw/v1/markers/<zählmarke> – konkrete Zählmarke abrufen

Bei jedem URL-Aufruf muss im HTTP HEADER mittels „X-WPVGW-API-KEY: <REST-API-Schlüssel>“ der zuvor erzeugte REST-API-Schlüssel mit übertragen werden – anderenfalls erscheint eine Meldung, dass der Zugriff nicht gestattet sei. Insbesondere für http://<wordpress-domain>/wp-json/wpvgw/v1/markers sind eine Vielzahl an Parameter möglich. Das vollständige Schema dazu (auch zur JSON-Ausgabe) kann über

OPTIONS http://<wordpress-domain>/wp-json/wpvgw/v1/markers

ausgegeben werden. Die eigentlichen Zählmarken-Daten können über GET-Aufrufe abgerufen werden. Es können maximal 100 Zählmarken-Daten pro Aufruf abgerufen werden.

Schema REST API
Schema der REST API.

Ein Kommentar zu „REST API verwenden“

  1. Ich habe in meiner neuen WP-Site euer Plugin installiert und meine Zählmarken importiert. Bis dahin sieht alle sehr gut aus.
    Die REST-API brauche ich aber nicht, oder?

    Kommentieren ↓

Kommentieren

Ihre E-Mail-Adresse wird nicht veröffentlicht. Angaben mit * sind Pflicht.

Welcher Tag kommt nach Donnerstag?
Ich habe die Datenschutzerklärung gelesen und willige in die Verarbeitung meiner Daten in diesem Formular ein.