ZUR ABNAHME
- Former user (Deleted) kannst du hier auch noch nen Blick drauf werfen?
Franziska Franz die API Dokus stellt ihr noch nicht online oder?
Zusammenfassung
Webservice | REST |
|---|---|
Objekt | JSON |
Trigger | GET, POST, PUT, DELETE |
Anbieter | PEIQ |
Syntax | Guthaben API |
Die API des Guthaben Features (CreditBundle) kann zum Abrufen, Anlegen, Editieren und Löschen von Guthaben-Konten, Guthaben-Bestellungen oder Guthaben-Paketen genutzt werden.
Inhaltsverzeichnis
Interne Beschreibung
Verfügbare Endpunkte für Guthaben-Konten (Credit Accounts)
Basis URL
https://yourdomain.com/api/v2/credit/accounts/{account_id}
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
GET
Get Credit Accounts by Filters
user_id
location_ids[]
Response
{
"total_results": 234,
"total_pages": 12,
"page": 1,
"page_size": 20,
"data": [
{
"id": "1",
"user_id": 1,
"created": "2020-07-07T00:00:00+00:00",
"updated": "2020-07-07T00:00:00+00:00",
"credits": 20
}
]
}
POST
Create credit account for user
user_id
PUT
Update credit account by account_id
account_id
DELETE
Delete credit account by account_id
account_id
Request
{
"add_credits": {
"credits": "10",
"description": "Initial Balance"
},
"remove_credits": {
"credits": "10",
"description": "Error Correction"
}
}
Verfügbare Endpunkte für Guthaben-Bestellungen (Credit Orders)
Basis URL
https://yourdomain.com/api/v2/credit/orders/{order_id}
Die Credit Order API ist der API Endpunkt der /wiki/spaces/CORE/pages/154272212 . Über die unten genannten Endpunkte können Bestellungen abgerufen, aufgegeben, geändert (Statusänderungen) oder gelöscht werden (Diese Funktion ist im Portal nicht vorhanden, nur über die API möglich).
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 /wiki/spaces/CORE/pages/154305073 . Ü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
[
{
"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"
}
]
POST
Create Credit Package
PUT
Update Credit Package by package_id
package_id
DELETE
Delete Credit Package by package_id
package_id
Request
{
"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"
}
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
Es sind keine Konfigurationsmöglichkeiten für die Schnittstelle vorhanden.
Bekannte Einschränkungen
s. allgemeine Bekannte Einschränkungen der PEIQ API Anbindung
Entwicklungsverlauf
Links zu Issues, Tickets, etc. Neueste zuerst:
Schnittstelle im Einsatz bei
[ALLIN]
Verwandte Themen
Verwandte Seiten
Filter by label
There are no items with the selected labels at this time.
Verwandte Labels
Ansprechpartner
Teil 2 - EXTERN für Kunden & Interessenten EXTERN
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 EXTERN
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
Guthaben verwalten
Guthaben hinzufügen
Guthaben abziehen
Guthaben-Konten filtern
Details EXTERN
Verfügbare Endpunkte für Guthaben-Konten
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.
GET
Get Credit Accounts by Filters
user_id
location_ids[]
POST
Create credit account for user
user_id
PUT
Update credit account by account_id
account_id
DELETE
Delete credit account by account_id
account_id
Response
{
"total_results": 234,
"total_pages": 12,
"page": 1,
"page_size": 20,
"data": [
{
"id": "1",
"user_id": 1,
"created": "2020-07-07T00:00:00+00:00",
"updated": "2020-07-07T00:00:00+00:00",
"credits": 20
}
]
}
{
"add_credits": {
"credits": "10",
"description": "Initial Balance"
},
"remove_credits": {
"credits": "10",
"description": "Error Correction"
}
}
Verfügbare Endpunkte für Guthaben-Bestellungen
Die Credit Order API ist der API Endpunkt der Guthaben-Bestellungen. Über die unten genannten Endpunkte können Bestellungen abgerufen, aufgegeben, geändert (Statusänderungen) oder gelöscht werden (Diese Funktion ist im Portal nicht vorhanden, nur über die API möglich).
GET
Get Credit Packages
no parameters
Get Credit Packages by package_id
package_id
POST
Create Credit Package
PUT
Update Credit Package by package_id
package_id
DELETE
Delete Credit Package by package_id
package_id
Response
[
{
"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"
}
]
Request
{
"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"
}
Release-Notes EXTERN
Monat 202X - Zusammenfassung
Text
Erweiterung FAQs EXTERN
Anleitung zum Setup EXTERN
Die API 2.0 Dokumentation ist in jedem Portal vorhanden. Zugang erhält man mit der Berechtigung “Zugang zur API Dokumentation”
Der Zugang zur API-Cloud Connect selbst ist jedoch pro Modul aktivierbar. Siehe hierfür die jeweiligen Angaben zum Setup.
Historie
| Version | Date | Comment |
|---|---|---|
| Current Version (v. 1) | 2020-09-27 09:07 | Boris Braun |
| v. 9 | 2024-02-09 14:46 | Kathrin Janka |
| v. 8 | 2024-02-08 14:32 | Kathrin Janka |
| v. 7 | 2022-08-18 08:38 | Former user |
| v. 6 | 2022-08-18 08:36 | Former user |
| v. 5 | 2022-03-15 15:19 | Former user |
| v. 4 | 2020-10-22 05:01 | Franziska Franz |
| v. 3 | 2020-10-06 08:12 | Boris Braun |
| v. 2 | 2020-09-28 09:18 | Boris Braun |
| v. 1 | 2020-09-27 09:07 | Boris Braun |