Versions Compared

Old Version 17

changes.mady.by.user Franziska Franz

Saved on

compared with

New Version 18

changes.mady.by.user Franziska Franz

Saved on

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 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 Cloud-Connect API kann von berechtigten Nutzern über die Administration & Moderation oder unter /admin/api oder über das Benutzermenü → Administration & Moderation → API 2.0 Dokumentation aufgerufen werden. Hier steht eine interaktive Entwicklerdokumentation zur Verfügung.

...

Grundsätzlich stehen all diejenigen APIs zur Verfügung, deren zugehöriges Modul im jeweiligen PORTAL aktiv ist. Einen Überblick, welche Module im PORTAL aktiv und damit auch welche APIs potenziell verfügbar sind, bietet die Modulübersicht. Diese kann von berechtigten Nutzern über das Benutzermenü → Administration & Moderation → steht unter API 2.0 BETA Dokumentation aufgerufen werdenin der Administration & Moderation zur Verfügung. Näheres siehe API 2.0 Dokumentation.

...

Expand
titleFormular: Editieren/ Deaktiveren/ Hinzufügen des API-Zugangs

Übergabe API-Zugang

[Name des Zugangs]



client id:

client secret:

aktive API

Lesend

Schreibend

Beitrags-API



Location-API


User-API



Newsletter-API



Veranstaltungskalender-API

Stellenmarkt-API

Kleinanzeigen-API

Routing-API

Federation-API Beitrag

Legende: “1” = aktiv, “0” = inaktiv, “-” = nicht vorhanden

1. Editieren/ Deaktiveren/ Hinzufügen des API-Zugangs

Um 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:

  • Der API-Zugang kann Livedaten beeinflussen und sollte entsprechend sorgsam eingesetzt werden.

  • Wird Dritten der API-Zugang vom Kunden zur Verfügung gestellt, wird empfohlen, dass der Kunde eigenständig mit diesen Dritten einen ADV-Vertrag (Vertrag zur Auftragsdatenverarbeitung) abschließt.

  • Über die User-API können nutzerbezogene Daten bezogen oder verändert werden.

3. Zugang zur API-Dokumentation 

  • Benutzer der Onlineplattform, mit entsprechender Berechtigung, erhalten Zugang zur API-Dokumentation.

  • Für externe Benutzer kann in der oben beschriebenen, systeminternen Dokumentation die API-Spezifikationsdatei heruntergeladen werden.

Basis URL

Code Block
https://yourdomain.com/api/v2/

Alle API Requests müsse über HTTPS gesendet werden. Requests über HTTP schlagen fehl. API Requests ohne Authorisierung werden ebenfalls fehlschlagen.

Findet die Konnektierung der API über eine htaccess-geschützte Staging-Umgebung statt, müssen Benutzername und Passwort für die Staging-Umgebung (nicht Client Credentials der API) in die URL geschrieben werden, z.B. https://user:password@portal06.peiq.dev/

Verwandte Seiten

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
cqllabel = "api" and space = "PPSD"

...