Zusammenfassung
| Info |
|---|
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 Routing API
Zum Abrufen , Erstellen, Editieren und Löschen von URL-Redirects
Erstellen von URL-Redirects
Editieren 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.
Löschen von URL-Redirects
Inhaltsverzeichnis
| Expand | ||||
|---|---|---|---|---|
| ||||
|
Detaillierte Beschreibung
Basis URL
| Code Block | ||
|---|---|---|
| ||
https://yourdomain.com/api/v2/routing/redirects |
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
| Status | ||||
|---|---|---|---|---|
|
Get Redirects by Filter
tag
page
page_size
Get Redirects by redirect_id
redirect_id
Response
| Code Block | ||
|---|---|---|
| ||
{
"id": "1",
"source": "/example/source",
"target": "https://www.example.com/example/source",
"tag": "Test Redirect Tag"
} |
| Status | ||||
|---|---|---|---|---|
|
Create Redirect
| Status | ||||
|---|---|---|---|---|
|
Update Redirect
| Status | ||||
|---|---|---|---|---|
|
Delete Redirect by ID
Request Body
| Code Block | ||
|---|---|---|
| ||
{
"source": "/example/source/import",
"target": "https://www.example.com/example/source/import",
"tag": "Test Redirect Tag Import"
} |
HTTP Status Codes
| Code Block | ||
|---|---|---|
| ||
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.
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
| Note |
|---|
Um ein versehentliches Manipulieren der Daten zu verhindern, ist die Benutzung auf die Lesenden Endpunkte (GET) beschränkt. |
Verwandte Themen
| Filter by label (Content by label) | ||||||
|---|---|---|---|---|---|---|
|