PORTAL und PPS Knowledge Base
Guthaben API
- Boris Braun
- Ilker Oygün
- Former user (Deleted)
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 und DELETE gesteuert. Die Zugriffskontrolle erfolgt hierbei über eine Implementierung nach OAuth V2 Standard.
Die API des Guthaben Features (CreditBundle) kann zum Abrufen, Anlegen, Editieren und Löschen von Guthaben-Konten, Guthaben-Bestellungen oder Guthaben-Paketen genutzt werden.
Funktionalitäten der Guthaben API
Abrufen von Guthaben-Konten, Guthaben-Bestellungen oder Guthaben-Paketen.
Anlegen von Guthaben-Konten, Guthaben-Bestellungen oder Guthaben-Paketen.
Editieren von Guthaben-Konten, Guthaben-Bestellungen oder Guthaben-Paketen.
Löschen von Guthaben-Konten, Guthaben-Bestellungen oder Guthaben-Paketen.
Inhaltsverzeichnis
Verfügbare Endpunkte für Guthaben-Konten (Credit Accounts)
Grundlegendes zur Beitrags API
Die Credit Account API ist der API Endpunkt der Guthaben-Konten. Über die unten genannten Endpunkte können die im PORTAL aktivierten Guthaben-Konten nach verschiedenen Filtern abgerufen werden. Außerdem können die Konten verwaltet und Guthaben abgezogen oder hinzugefügt werden
Verfügbare Endpunkte für Guthaben-Konten (Credit Accounts)
GET
Get Credit Orders by Filters
user_id
locations_ids[]
created_start
created_end
updated_start
updated_end
Get Credit Order by order_id
order_id
Response
{
"total_results": 234,
"total_pages": 12,
"page": 1,
"page_size": 20,
"data": [
{
"id": "1",
"user_id": 1,
"name": "Package SMALL",
"created": "2020-07-07T00:00:00+00:00",
"updated": "2020-07-07T00:00:00+00:00",
"credits": 1,
"price": 1,
"description": "Package description",
"address": {
"first_name": "Max",
"last_name": "Power",
"street": "Example Street",
"street_number": "123",
"zipcode": "86159",
"city": "Augsburg",
"company": "Company 1",
"phone": "08212849204"
},
"status": "requested"
}
]
}POST
Create Credit Order
PUT
Update Credit Order bei order_id
order_id
DELETE
Delete Credit Order by order_id
order_id
Request
{
"user_id": 1,
"package_id": 1,
"created": "2020-07-07T00:00:00+00:00",
"updated": "2020-07-07T00:00:00+00:00",
"address": {
"first_name": "Max",
"last_name": "Power",
"street": "Example Street",
"street_number": "123",
"zipcode": "86159",
"city": "Augsburg",
"company": "Company 1",
"phone": "08212849204"
},
"status": "requested"
}Verfügbare Endpunkte für Guthaben-Bestellungen (Credit Orders)
Basis URL
https://yourdomain.com/api/v2/credit/packages/{package_id}Die Credit Package API ist der API Endpunkt der Guthaben-Pakete. Über die unten genannten Endpunkte können Guthaben-Pakete abgerufen, angelegt, geändert oder gelöscht werden.
get
Get Credit Packages
no parameters
Get Credit Packages by package_id
package_id
Response
post
Create Credit Package
put
Update Credit Package by package_id
package_id
delete
Delete Credit Package by package_id
package_id
Request
Berechtigte Benutzer:innen
Die Guthaben API ist eine Adminfunktion, welche Benutzer:innen mit der Berechtigung “Zugang zur API-Dokumentation“abrufen dürfen.
Die interaktive Bedienung - Try it out
Die API 2.0 BETA Dokumentation kann bereits ohne große Programmierkenntnisse oder ein darauf ausgerichtetes Programm bedient werden. Hierfür gibt es die “Try-it-out” - Funktion.
Jeder lesende (GET) Endpunkt der Dokumentation hat einen “Try it out” Button. Hierüber können Daten nach den im Front-End vorliegenden Filtern aus dem Live-System abgerufen werden. Bedingung für das Benutzen der Funktion ist ein gültiger API key .
Der 'Try it out' Button
Um ein versehentliches Manipulieren der Daten zu verhindern, ist die Benutzung auf die lesenden Endpunkte (GET) beschränkt.
Trouble Shooting bei HTTP Status Codes
400 - Bad Request
404 - Not Found
Verwandte Seiten
Nur für PEIQ-Mitarbeiter:innen
https://peiq.atlassian.net/wiki/x/qACMCg