Versions Compared

Old Version 2

changes.mady.by.user Boris Braun

Saved on

compared with

New Version Current

changes.mady.by.user Ilker Oygün

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

  • Zum Abrufen von Guthaben-Konten, Guthaben-Bestellungen oder Guthaben-Paketen.

  • Anlegen von Guthaben-Konten, Editieren und Löschen Guthaben-Bestellungen oder Guthaben-Paketen.

  • Editieren von Guthaben-Konten, Guthaben-Bestellungen oder Guthaben-Paketen.

  • Es handelt sich bei der Stellenmarkt-API um eine Public API

  • Zur Aktivierung des Features ist eine Beauftragung seitens des Kunden notwendigLöschen von Guthaben-Konten, Guthaben-Bestellungen oder Guthaben-Paketen.

Inhaltsverzeichnis

Expand
titleInhaltsverzeichnis anzeigen
Table of Contents
maxLevel4

Deataillierte 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
colourBlue
titleGET

Get Credit Accounts by Filters

  • user_id

  • location_ids[]

Response

Code Block
languagejson
{
  "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
colourGreen
titlePOST

  • Create credit account for user

    • user_id

Status
colourYellow
titlePUT

  • Update credit account by account_id

    • account_id

status

colourRed
titledelete

  • Delete credit account by account_id

    • account_id

Request

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

Konten (Credit Accounts)

Status
colourBlue
titleGET

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
languagejson
{
  "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
colourGreen
titlePOST

Create Credit Order

Status
colourYellow
titlePUT

Update Credit Order bei order_id

  • order_id

Status
colourRed
titleDELETE

Delete Credit Order by order_id

  • order_id

Request

Code Block
languagejson
{
  "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 Guthaben-Pakete. Über die unten genannten Endpunkte können Guthaben-Pakete abgerufen, angelegt, geändert oder gelöscht werden.

Status
colourBlue
titleget

Get Credit Packages

  • no parameters

Get Credit Packages by package_id

  • package_id

Response

Code Block
languagejson
[
  {
    "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
colourGreen
titlepost

Create Credit Package

Status
colourYellow
titleput

Update Credit Package by package_id

  • package_id

Status
colourRed
titledelete

Delete Credit Package by package_id

  • package_id

Request

Code Block
languagejson
{
  "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

Zur Aktivierung des Features ist eine Beauftragung seitens des Kunden notwendig.

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

ist in jedem Portal vorhanden. Zugang erhält man mit der Berechtigung “Zugang zur API Dokumentation”

Verwandte Themen

Filter by label (Content by label)showLabels

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.

 Trouble Shooting bei HTTP Status Codes

400 - Bad Request

Insert excerpt
API 2.0 Dokumentation PORTAL
API 2.0 Dokumentation PORTAL
name400
nopaneltrue

404 - Not Found

Insert excerpt
API 2.0 Dokumentation PORTAL
API 2.0 Dokumentation PORTAL
name404
nopaneltrue

Verwandte Seiten

Filter by label (Content by label)
showLabelsfalse
maxCheckboxfalse
showSpacefalse
reversefalse
cqllabel in ( "api" , = "api-dokumentation" , "schnittstellen" , "guthaben" ) and space = "PPSD"PUPKB"

Include Page
Disclaimer der PEIQ PORTAL - Produktdokumentation
Disclaimer der PEIQ PORTAL - Produktdokumentation

Nur für PEIQ-Mitarbeiter:innen
https://peiq.atlassian.net/wiki/x/qACMCg