Verfügbar ab dem „Marketer“-Tarif.
Diese Seite bietet einen allgemeinen Überblick. Die vollständige, stets aktuelle REST-API-Referenz finden Sie in Ihrem WordPress-Adminbereich — weiter zu Dashboard > Pretty Links > Entwicklertools > Dokumentation für vollständige Beispiele für Anfragen und Antworten.
Dieser Leitfaden ist Teil der Übersicht über das Add-on „Pretty Links Developer Tools“, der Einstiegspunkt für das Add-on „Developer Tools“.
Wo Sie die vollständige Quellenangabe finden
Gehen Sie in der WordPress-Admin-Seitenleiste zu Dashboard > Pretty Links > Entwicklertools > Dokumentation.
Auf der Registerkarte „Dokumente“ werden alle Endpunkte mit ihrer HTTP-Methode, ihren Parametern, dem Format des Anfragetextes, dem Format der Antwort sowie Beispielaufrufen angezeigt. Da diese Informationen aus Ihrer Installation bereitgestellt werden, entsprechen sie stets Ihrer aktuellen Version von Pretty Links – Sie müssen sich also keine Gedanken über veraltete Online-Dokumentationen machen.
Öffnen Sie während der Arbeit den Reiter „Dokumente“ in einem zweiten Browser-Tab. Er ist die verlässliche Informationsquelle.
Endpunkt-Übersicht
Hier ist eine kurze Übersicht über die verfügbaren Funktionen, damit Sie schon vor dem Durchlesen der Dokumentation in der App wissen, welche Möglichkeiten es gibt.
Pretty Links (CRUD)
- Liste der „Pretty Links“ — Alle Ihre „Pretty Links“ anzeigen, mit Filter- und Paginierungsfunktion;
- Einen einzelnen Pretty Link erstellen — Einen Link anhand seiner ID suchen;
- Einen „Pretty Link“ erstellen — Einen neuen Link programmgesteuert hinzufügen. Nützlich für Migrationen, Massenimporte oder die automatische Erstellung von Links aus einem anderen System;
- Einen „Pretty Link“ aktualisieren — Die Ziel-URL, den Slug, den Weiterleitungstyp, den Namen oder andere Felder eines bestehenden Links ändern;
- Einen Pretty Link löschen — Einen Link in den Papierkorb verschieben oder dauerhaft löschen.
Webhook-Abonnements
- Abonnieren — Ein neues Webhook-Abonnement programmgesteuert erstellen (POST);
- Abmelden — Ein Webhook-Abonnement anhand der ID entfernen (DELETE).
Diese sind nützlich, wenn ein externes System den Lebenszyklus seiner eigenen Webhook-Abonnements selbst verwalten muss – beispielsweise bei einer Integration, die sich bei Aktivierung selbst registrieren und bei Deaktivierung aufräumen möchte. Um die aktuelle Liste der Abonnements anzuzeigen, nutzen Sie den Bildschirm „Webhooks“ im Admin-Bereich.
Authentifizierung
Für alle Endpunkte ist der API-Schlüssel der Website erforderlich, der entweder im PRLI-API-KEY Kopfzeile oder die Genehmigung Kopfzeile. Siehe API-Schlüssel wo man es findet und wie man es wiederherstellen kann.
Der REST-Namensraum lautet pl/v1 — zum Beispiel, https://yoursite.com/wp-json/pl/v1/links.
Auf der Registerkarte „Docs“ in der App werden das genaue Header-Format und ein Curl-Beispiel angezeigt, das Sie kopieren können.
Antwortformat
Alle Antworten liegen im JSON-Format vor. Erfolgreiche Antworten geben einen 2xx-Statuscode zurück, wobei die entsprechenden Daten im Hauptteil enthalten sind. Bei Fehlern wird ein 4xx- oder 5xx-Statuscode zurückgegeben, dessen JSON-Hauptteil beschreibt, was schiefgelaufen ist.
Es gelten die üblichen HTTP-Konventionen:
200 OK— Lesen erfolgreich;201 Erstellt— Erstellung erfolgreich;400 Ungültige Anfrage— Ihre Anfrage war fehlerhaft;401 Nicht autorisiert— Fehlender oder ungültiger API-Schlüssel;404 Nicht gefunden— Der Link oder die Ressource existiert nicht;500 Interner Serverfehler— Auf dem Server ist ein Fehler aufgetreten.
Tipps zur Arbeit mit der API
Beginnen Sie mit einem List-Aufruf. Die erste Anfrage, die Sie ausprobieren sollten, lautet: “Alle meine Pretty Links auflisten.” Damit werden Ihr API-Schlüssel, Ihr URL-Format und die Einrichtung Ihres Tools auf einen Schlag überprüft.
Die genauen Feldnamen finden Sie in der Dokumentation innerhalb der App. Die Liste der Felder eines Pretty Links ist im Admin-Bereich dokumentiert. Raten Sie nicht einfach bei den Feldnamen, sondern kopieren Sie diese aus der Dokumentation, um Tippfehler zu vermeiden.
Testen Sie die Aufrufe zum Erstellen und Aktualisieren zunächst auf einer Staging-Site. Ein Tippfehler in einem Skript zur Massenerstellung kann Hunderte von fehlerhaften Links erzeugen. Führen Sie das Skript zunächst in einer Staging-Umgebung aus, überprüfen Sie das Ergebnis und leiten Sie die Links anschließend auf die Produktionsumgebung weiter.
Verwenden Sie Webhooks anstelle von Polling. Wenn Sie den „List“-Endpunkt regelmäßig aufrufen, um nach Änderungen zu suchen, richten Sie stattdessen ein Webhook-Abonnement ein. So erhalten Sie Änderungen in Echtzeit, ohne dass Sie sich Gedanken über Ratenbeschränkungen machen müssen.
Überprüfen Sie das Ereignisprotokoll, wenn ein Webhook nicht ausgelöst wird. Gehen Sie nicht einfach davon aus – überprüfen Sie es. Im Ereignisprotokoll wird angezeigt, ob Pretty Links die Anfrage tatsächlich gesendet hat und welche Antwort Ihr Endpunkt zurückgegeben hat.
Für alles andere gilt: Der Reiter „Dokumente“ in der App ist die maßgebliche Quelle. Setzen Sie ein Lesezeichen dafür.