Versions Compared

Key

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

Status
colourPurple
titlezur abnahme
Former user (Deleted)

Zusammenfassung

Webservice

REST

Objekt

JSON

Trigger

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

, DELETE

Anbieter

PEIQ

Syntax

Routing-API

Info

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.

Produkt (Label)

Portal

Übergeordnetes Modul (Label)

API,

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

Interne 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 Blocklanguagehtml

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

Aktivierung Feature

Aufwand Technik

Als Change Request (Releaseunabhängig)

https://docs.google.com/document/d/1loSYAex--vFIdZ0OAAfcw8buiiCKFlZpdm3QpkvcIr0/edit?ts=5d9c7c36#heading=h.9blbyv4a4qgm

0,25PH

Die API 2.0 Dokumentation ist in jedem Portal vorhanden. Zugang erhält man mit der Berechtigung “Zugang zur API Dokumentation”

Der Zugang zur /wiki/spaces/CORE/pages/44400763 selbst ist jedoch pro Modul aktivierbar. Siehe hierfür die jeweiligen Angaben zum Setup.

Konfigurationsparameter

Warning

Es sind keine Konfigurationsmöglichkeiten für die Schnittstelle vorhanden.

Bekannte Einschränkungen

Note

Entwicklungsverlauf

Modul im Einsatz bei

  • [ALLIN] (all-in.de)

    Status
    colourGreen
    titleOnline (V2)

  • Alte Version (V1) genutzt von:

    Verwandte Themen

    Verwandte Seiten

    Filter by label (Content by label)showLabelsfalseshowSpacefalse

    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 = "api" and space = "
    CORE
    PUPKB"

    Verwandte Labels

    Related Labels
    labelsapi

    Ansprechpartner

    Teil 2 - EXTERN für Kunden & Interessenten
    Status
    colourGreen
    titleextern

    Note

    In diesem Teil werden über sogenannte Auszüge Snippets für die extern zugänglichen Dokumente und Seiten erstellt. Diese Auszüge werden vom Customer Success auf weitere Seiten kuratiert.

    Neue Auszüge können über /auszug erstellt werden.

    Änderungen an bereits bestehenden Auszügen dürfen nicht vorgenommen werden. Siehe hierzu die Anleitung /wiki/spaces/CORE/pages/44204087.

    Allgemeine Beschreibung
    Status
    colourGreen
    titleextern

    Note

    Beschreibt in wenigen Sätzen die Ziele bzw. Vorteile des Moduls / Features sowie als Stichwortliste dessen Leistungsumfang. Die Allgemeine Beschreibung ist als Einstieg für den Kunden zu verstehen und beantwortet folgende Fragen: Warum brauche ich das? Was kann das?

    Excerpt

    Details
    Status
    colourGreen
    titleextern

    Note

    Externe Produktdokumentation für die Kunden (Customer Success): Inhalt der aktuell FAQ benannten Dokumente, aber nicht als Frage-Antwort, sondern einfach als Dokumentation für den (potenziellen) Kunden (ohne kritische interne Hinweise, ohne Aufwände, vor allem ohne Links auf die interne CORE-Umgebung).

    Excerpt

    Release-Notes
    Status
    colourGreen
    titleextern

    Excerpt

    Monat 202X - Zusammenfassung

    Text

    Excerpt

    Monat 202X - Zusammenfassung

    Text

    Anleitung zum Setup
    Status
    colourGreen
    titleextern

    Excerpt

    Historie

    change-history

    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