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

title	Inhaltsverzeichnis anzeigen

Table of Contents

maxLevel	4

Deataillierte Beschreibung

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

Basis URL

Code Blockhttps://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 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

Konten (Credit

Orders

Accounts)

Basis URL

code

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

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

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

Berechtigte Nutzer

Die Guthaben API ist eine Adminfunktion, welche Nutzer 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”

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

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

Versions Compared

Old Version 2

New Version 3

Key

Inhaltsverzeichnis

Deataillierte Beschreibung

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

Basis URL

Grundlegendes zur Beitrags API

Response

Request

Verfügbare Endpunkte für Guthaben-

Konten (Credit

Accounts)

Basis URL

Response

Request

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

Basis URL

Response

Request

Setup & Konfiguration

Berechtigte Nutzer

Die Interaktive Bedienung - Try it out

Verwandte Themen

Page Comparison

Versions Compared

Old Version 2

New Version 3

Key

Inhaltsverzeichnis

Deataillierte Beschreibung

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

Basis URL

Grundlegendes zur Beitrags API

Response

Request

Verfügbare Endpunkte für Guthaben-

Konten (Credit

Accounts)

Basis URL

Response

Request

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

Basis URL

Response

Request

Setup & Konfiguration

Berechtigte Nutzer

Die Interaktive Bedienung - Try it out

Verwandte Themen