Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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 Routing API

  • Abrufen von URL-Redirects

  • Erstellen von URL-Redirects

  • Editieren von URL-Redirects

  • Löschen von URL-Redirects

Inhaltsverzeichnis

Expand
titleInhaltsverzeichnis anzeigen
Table of Contents
maxLevel4

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
colourBlue
titleGET

  • Get Redirects by Filter

    • tag

    • page

    • page_size

  • Get Redirects by redirect_id

    • redirect_id

Response

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

Status
colourGreen
titlePOST

  • Create Redirect

Status
colourYellow
titlePUT

  • Update Redirect

Status
colourRed
titleDelete

  • Delete Redirect by ID

Request Body

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

HTTP Status Codes

Code Block
languagehtml
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

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
cqllabel in ( "api" , "api-dokumentation" , "schnittstellen" ) and space = "PPSD"