Status | ||||
---|---|---|---|---|
|
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 |
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)
Funktionalitäten der Routing API
Abrufen von URL-Redirects
Erstellen von URL-Redirects
Editieren von URL-Redirects
Löschen von URL-Redirects
Inhaltsverzeichnis
Expand | ||||
---|---|---|---|---|
| ||||
|
Interne 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" } |
Trouble Shooting bei HTTP Status Codes
Setup & Konfiguration
Aktivierung Feature
Aufwand Technik
Als Change Request (Releaseunabhängig)
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
Links zu Issues, Tickets, etc. Neueste zuerst:
Modul im Einsatz bei
[ALLIN] (all-in.de)
Status | ||||
---|---|---|---|---|
|
Alte Version (V1) genutzt von:
[SIEGEN] (siegener-zeitung.de)
Status colour Yellow title Version V1
Verwandte Themen
Verwandte Seiten
Verwandte Themen
Filter by label (Content by label) | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
|
Verwandte Labels
Related Labels | ||
---|---|---|
|
Ansprechpartner
Teil 2 - EXTERN für Kunden & Interessenten
Status | ||||
---|---|---|---|---|
|
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 Änderungen an bereits bestehenden Auszügen dürfen nicht vorgenommen werden. Siehe hierzu die Anleitung /wiki/spaces/CORE/pages/44204087. |
Allgemeine Beschreibung
Status | ||||
---|---|---|---|---|
|
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? |
Details
Status | ||||
---|---|---|---|---|
|
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). |
Release-Notes
Status | ||||
---|---|---|---|---|
|
Excerpt |
---|
Monat 202X - ZusammenfassungText |
Excerpt |
---|
Monat 202X - ZusammenfassungText |
Anleitung zum Setup
Status | ||||
---|---|---|---|---|
|
Historie
change-historyInclude Page | ||||
---|---|---|---|---|
|
Nur für PEIQ-Mitarbeiter:innen
https://peiq.atlassian.net/wiki/x/HITQAg