PORTAL und PPS Knowledge Base

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Mithilfe der PEIQ Cloud-Connect APIs (engl. Application Programming Interfaces, Programmierschnittstellen) können Verlage Teile ihrer bestehenden Systeme und Produkte mit dem PEIQ PORTAL verbinden. Alle Cloud-Connect APIs sind nach der REST-Architektur aufgebaut. Der Zugriff wird dabei über die Standard HTTP-Methoden GET, POST, PUT und DELETE gesteuert. Die Zugriffskontrolle erfolgt hierbei über eine Implementierung nach OAuth V2 Standard.

Die API des Routing-Moduls kann zum Abrufen, Erstellen, Editieren und Löschen von URL-Redirects verwendet werden.

Funktionalitäten der Routing API

  • Abrufen von URL-Redirects

  • Erstellen von URL-Redirects

  • Editieren von URL-Redirects

  • Löschen von URL-Redirects

Inhaltsverzeichnis

 Inhaltsverzeichnis anzeigen

Grundlegendes zur Routing API

Die API des Routing-Moduls kann zum Abrufen, Erstellen, Editieren und Löschen von URL-Redirects verwendet werden.

Verfügbare Endpunkte

GET

  • Get Redirects by Filter

    • tag

    • page

    • page_size

  • Get Redirects by redirect_id

    • redirect_id

Response

{
  "id": "1",
  "source": "/example/source",
  "target": "https://www.example.com/example/source",
  "tag": "Test Redirect Tag"
}

POST

  • Create Redirect

PUT

  • Update Redirect

DELETE

  • Delete Redirect by ID

Request Body

{
  "source": "/example/source/import",
  "target": "https://www.example.com/example/source/import",
  "tag": "Test Redirect Tag Import"
}

HTTP Status Codes

200 - Success           Alles hat wie erwartet funktioniert
201 - Redirect Successfully Created
204 - Redirect Successfully Updated/Deleted
400 - Bad Reqest        Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body
404 - Redirect Not Found 
409 - Duplicate Entry   Das Feld "source" muss einzigartig sein.

Verwandte Themen

Disclaimer

Für die vorliegende Systemübersicht/Publikation behalten wir uns alle Rechte vor. Nachdruck, Vervielfältigung und Verbreitung (auch auszugsweise) ist nur mit schriftlicher Genehmigung der PEIQ Publishing GmbH & Co. KG erlaubt. Wir behalten uns vor, die Systemübersicht/Publikation jederzeit ohne vorherige Ankündigung zu ändern und/oder zu erweitern. Die vorliegenden Angaben dienen lediglich Informationszwecken. Die PEIQ Publishing GmbH & Co. KG übernimmt keinerlei Haftung und/oder Garantie für Fehler und/oder unvollständige Angaben in der Systemübersicht/Publikation, mit Ausnahme von vorsätzlich falschen oder arglistig verschwiegenen Angaben. Da unsere Software laufend weiter entwickelt wird, handelt es sich bei den vorliegenden nur um allgemeine Angaben. Es handelt sich weder um eine Zusicherung von Mindestvertragsinhalten, noch um Beschaffenheitsgarantien im Sinne des § 443 BGB.

  • No labels