Versions Compared

Old Version 2

changes.mady.by.user Boris Braun

Saved on

compared with

New Version Current

changes.mady.by.user Ilker Oygün

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 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
titleInhaltsverzeichnis anzeigen
Table of Contents
maxLevel4

Detaillierte Beschreibung

Basis URL

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

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

Trouble Shooting bei HTTP Status Codes

Code Blocklanguage

html200 - 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”

    Request

    Insert excerpt
    API 2.0 Dokumentation PORTAL
    API 2.0 Dokumentation PORTAL
    name400
    nopaneltrue

    404 - Not Found

    Insert excerpt
    API 2.0 Dokumentation PORTAL
    API 2.0 Dokumentation PORTAL
    name404
    nopaneltrue

    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

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

    Include Page
    Disclaimer der PEIQ PORTAL - Produktdokumentation
    Disclaimer der PEIQ PORTAL - Produktdokumentation

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