PORTAL und PPS Knowledge Base

Routing API

Owned by Boris Braun
Last updated: 2024-10-25 by Ilker Oygün
1 min read

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

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" }

Trouble Shooting bei HTTP Status Codes

400 - Bad Request

404 - Not Found

409 - Conflict

Es wird versucht, ein Duplikat anzulegen. source muss einzigartig sein. Für die in source spezifizierten URL ist bereits ein Redirect angelegt.

Verwandte Themen

 

Nur für PEIQ-Mitarbeiter:innen
https://peiq.atlassian.net/wiki/x/HITQAg

Impressum