Zusammenfassung

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 Stellenmarkt API

Zum Abrufen, Erstellen, Editieren und Löschen von URL-Redirects .
Es handelt sich bei der Routing-API um eine Public API
Zur Aktivierung des Features ist eine Beauftragung seitens des Kunden notwendig.

Inhaltsverzeichnis

Inhaltsverzeichnis anzeigen

Detaillierte Beschreibung

Basis URL

https://yourdomain.com/api/v2/routing/redirects

Die Routing API ermöglicht es systemgesteuert Redirects (URL Umleitung) zu lesen, anzulegen, zu löschen oder zu manipulieren. Dabei ist zu beachten, dass ein Redirect keine Systemseiten übersteuern kann.

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.

Setup & Konfiguration

Zur Aktivierung des Features ist eine Beauftragung seitens des Kunden notwendig.
Die API 2.0 Dokumentation ist in jedem Portal vorhanden. Zugang erhält man mit der Berechtigung “Zugang zur API Dokumentation”

Routing-API