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

Detaillierte Beschreibung

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.

Berechtigte Nutzer

Die Beitrags API ist eine Adminfunktion, welche Nutzer mit der Berechtigung “Zugang zur API-Dokumentation“abrufen dürfen.

Die Interaktive Bedienung - Try it out

Die API 2.0 BETA Dokumentation kann bereits ohne große Programmierkenntnisse oder ein darauf ausgerichtetes Programm bedient werden. Hierfür gibt es die “Try-it-out” - Funktion.

Jeder Lesende (GET) Endpunkt der Dokumentation hat einen “Try it out” Button. Hierüber können Daten nach den im Front-End vorliegenden Filtern aus dem Live-System abgerufen werden. Bedingung für das Benutzen der Funktion ist ein gültiger API key .

^{Der 'Try it out' Button}

Um ein versehentliches Manipulieren der Daten zu verhindern, ist die Benutzung auf die Lesenden Endpunkte (GET) beschränkt.

Routing API