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 erfolgt dadurch mit den Standard HTTP-Methoden GET, POST, PUT und DELETE. Die Zugriffskontrolle erfolgt hierbei über eine Implementierung nach OAuth V2 Standard. Die Dokumentation der Gogol Cloud-Connect API kann unter /admin/api oder über das Benutzermenü → Administration & Moderation → API 2.0 BETA Dokumentation aufgerufen werden. Hier steht eine interaktive Entwicklerdokumentation zur Verfügung. |
...
Anbindung bestehenden Systeme und Produkte
Interaktive Entwicklerdokumentation mit potentiellen Anwendungsmöglichkeiten der verfügbaren APIs
Verwendung des OAuth-V2-Standards für die ZugriffskontrolleEinfache Nutzung dank “Try it out”-Funktion
Inhaltsverzeichnis
Expand | ||||
---|---|---|---|---|
| ||||
|
...
Dokumentation zur PEIQ Cloud-Connect API
Die Dokumentation zur PEIQ Cloud-Connect API Dokumentation kann im Portal PORTAL über die “Administration & Moderation” erreicht werden. Unter dem Menüpunkt “API 2.0 BETA Dokumentation” findet sich eine interaktive Entwicklerdokumentation, die eine Übersicht der potentiellen Anwendungsmöglichkeiten der diversen APIs im PEIQ Portal PORTAL bietet. Voraussetzung für den Zugang zur interaktiven Dokumentation ist die Berechtigung “Zugang zur API-Dokumentation”.
Modulübersicht
Die Modulübersicht zeigt auf einen BlickNäheres hierzu siehe API 2.0 Dokumentation.
Verfügbare APIs im PEIQ PORTAL
Grundsätzlich stehen all diejenigen APIs zur Verfügung, deren zugehöriges Modul im jeweiligen PORTAL aktiv ist. Einen Überblick, welche Module im jeweiligen Portal PORTAL aktiv und damit auch welche APIs potenziell verfügbar sind. Um eine API benutzen zu können, muss diese für das jeweilige Modul jedoch von PEIQ eingerichtet werden., bietet die Modulübersicht. Diese kann von berechtigten Nutzern über das Benutzermenü → Administration & Moderation → API 2.0 BETA Dokumentation aufgerufen werden. Näheres siehe API 2.0 Dokumentation.
Federation API Beitrag
Requests und Autorisierung
...
Expand | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||
Übergabe API-Zugang
Legende: “1” = aktiv, “0” = inaktiv, “-” = nicht vorhanden 1. Editieren/ Deaktiveren/ Hinzufügen des API-ZugangsUm einen API-Zugang zu Editieren/ Deaktivieren oder Hinzuzufügen, kann ein Ticket im PEIQ Service Desk, unter Nennung des API-Zugang Namens, eingestellt werden. Das Löschen oder Anpassen kann dann nach Aufwand erfolgen. 2. Wichtige Hinweise:
3. Zugang zur API-Dokumentation
|
“Try it out”-Funktion
Die Dokumentation selbst ist nicht nur rein informativer Natur, sondern bietet darüber hinaus die Möglichkeit, sämtliche API-GET-Endpunkte direkt zu testen. Über diese “Try it out”-Funktion können also Live-Daten aus dem System direkt im JSON-Format exportiert
|
Verfügbare APIs im PEIQ Portal
...
Location-API
...
Beitrags-API
...
Newsletter API
...
Benutzer API
...
Routing-API
...
Veranstaltungskalender-API
...
Kleinanzeigenmarkt-API
...
Stellenmarkt API
...
Verwandte Seiten
Filter by label (Content by label) | ||||||
---|---|---|---|---|---|---|
|
...