Status

colour	Purple
title	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

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

, DELETE

Anbieter

PEIQ

Syntax

Guthaben API

Info

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.

Produkt (Label)

portal

Modul (Label)

guthaben, API

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

Expand

title	Inhaltsverzeichnis anzeigen

Table of Contents

maxLevel	4

Interne Beschreibung

Verfügbare Endpunkte für Guthaben-Konten (Credit Accounts)

Basis URL

Code Block
https://yourdomain.com/api/v2/credit/accounts/{account_id}

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 PORTAL aktivierten Guthaben-Konten nach verschiedenen Filtern abgerufen werden. Außerdem können die Konten verwaltet und Guthaben abgezogen oder hinzugefügt werden

Status

colour	Blue
title	GET

Get Credit Accounts by Filters

user_id

location_ids[]

Response

Code Block

language	json

{
  "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
    }
  ]
}

Status

colour	Green
title	POST

Create credit account for user
- user_id

Status

colour	Yellow
title	PUT

Update credit account by account_id
- account_id

Status

colour	Red
title	delete

Delete credit account by account_id
- account_id

Request

Code Block

language	json

{
  "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

Code Block
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).

Konten (Credit Accounts)

Status

colour	Blue
title	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

Code Block

language	json

{
  "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"
    }
  ]
}

Status

colour	Green
title	POST

Create Credit Order

Status

colour	Yellow
title	PUT

Update Credit Order bei order_id

order_id

Status

colour	Red
title	DELETE

Delete Credit Order by order_id

order_id

Request

Code Block

language	json

{
  "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

Code Block
https://yourdomain.com/api/v2/credit/packages/{package_id}

Die Credit Package API ist der API Endpunkt der /wiki/spaces/CORE/pages/154305073 Guthaben-Pakete. Über die unten genannten Endpunkte können Guthaben-Pakete abgerufen, angelegt, geändert oder gelöscht werden.

Status

colour	Blue
title	get

Get Credit Packages

no parameters

Get Credit Packages by package_id

package_id

Response

Code Block

language	json

[
  {
    "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"
  }
]

Status

colour	Green
title	post

Create Credit Package

Status

colour	Yellow
title	put

Update Credit Package by package_id

package_id

Status

colour	Red
title	delete

Delete Credit Package by package_id

package_id

Request

Code Block

language	json

{
  "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)

https://docs.google.com/document/d/1loSYAex--vFIdZ0OAAfcw8buiiCKFlZpdm3QpkvcIr0/edit?ts=5d9c7c36#heading=h.9blbyv4a4qgm

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
s. allgemeine Bekannte Einschränkungen der PEIQ API Anbindung

Entwicklungsverlauf

Links zu Issues, Tickets, etc. Neueste zuerst:

https://peiq.atlassian.net/browse/PORTAL-158

Epics

Schnittstelle im Einsatz bei

[ALLIN]

Ansprechpartner

Teil 2 - EXTERN für Kunden & Interessenten
Status
colour Green
title extern

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 /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
Status
colour Green
title extern

InfoMithilfe 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

Table of Contents

Details
Status
colour Green
title 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.

Status

colour	Blue
title	GET

Get Credit Accounts by Filters

user_id
location_ids[]

Status

colour	Green
title	POST

Create credit account for user
- user_id

Status

colour	Yellow
title	PUT

Update credit account by account_id
- account_id

Status

colour	Red
title	delete

Delete credit account by account_id
- account_id

Response

Code Block

language	json

{
  "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
    }
  ]
}

Code Block

language	json

{
  "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).

Status

colour	Blue
title	get

Get Credit Packages

no parameters

Get Credit Packages by package_id

package_id

Status

colour	Green
title	post

Create Credit Package

Status

colour	Yellow
title	put

Update Credit Package by package_id

package_id

Status

colour	Red
title	delete

Delete Credit Package by package_id

package_id

Response

Code Block

language	json

[
  {
    "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

Code Block

language	json

{
  "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
Status
colour Green
title extern

Monat 202X - Zusammenfassung

Text

Erweiterung FAQs
Status
colour Green
title extern

Anleitung zum Setup
Status
colour Green
title 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

change-history

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 .

Image Added

^{Der 'Try it out' Button}

Note
Um ein versehentliches Manipulieren der Daten zu verhindern, ist die Benutzung auf die lesenden Endpunkte (GET) beschränkt.

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Zusammenfassung

Inhaltsverzeichnis

Interne Beschreibung

Verfügbare Endpunkte für Guthaben-Konten (Credit Accounts)

Basis URL

Grundlegendes zur Beitrags API

Response

Request

Verfügbare Endpunkte für Guthaben-

Basis URL

Konten (Credit Accounts)

Response

Request

Verfügbare Endpunkte für Guthaben-Bestellungen (Credit Orders)

Basis URL

Response

Request

Setup & Konfiguration

Konfigurationsparameter

Bekannte Einschränkungen

Entwicklungsverlauf

Links zu Issues, Tickets, etc. Neueste zuerst:

Epics

Schnittstelle im Einsatz bei

Verwandte Themen

Ansprechpartner

Teil 2 - EXTERN für Kunden & Interessenten StatuscolourGreentitleextern

Allgemeine Beschreibung StatuscolourGreentitleextern

Details StatuscolourGreentitleextern

Verfügbare Endpunkte für Guthaben-Konten

Response

Verfügbare Endpunkte für Guthaben-Bestellungen

Response

Request

Release-Notes StatuscolourGreentitleextern

Monat 202X - Zusammenfassung

Erweiterung FAQs StatuscolourGreentitleextern

Anleitung zum Setup StatuscolourGreentitleextern

Historie

Berechtigte Benutzer:innen

Die interaktive Bedienung - Try it out

Trouble Shooting bei HTTP Status Codes

400 - Bad Request

404 - Not Found

Verwandte Seiten

Teil 2 - EXTERN für Kunden & Interessenten
Status
colour Green
title extern

Allgemeine Beschreibung
Status
colour Green
title extern

Details
Status
colour Green
title extern

Release-Notes
Status
colour Green
title extern

Erweiterung FAQs
Status
colour Green
title extern

Anleitung zum Setup
Status
colour Green
title extern

`400` - Bad Request

`404` - Not Found