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 Benutzer API dient zum Anlegen, Editieren, Löschen und Auslesen von Benutzer:innen & Gruppen. Darüber hinaus können Profilbilder über die API manipuliert werden.
Funktionalitäten der Benutzer API
Anlegen und Editieren von Benutzer:innen & Gruppen
Löschen und Auslesen von Benutzer:innen & Gruppen
Inhaltsverzeichnis
Grundlegendes zur Benutzer API
Die Benutzer API dient zum Anlegen, Editieren, Löschen und Auslesen von Benutzer:innen & Gruppen. Darüber hinaus können Profilbilder über die API manipuliert werden.
Verfügbare Endpunkte für User
Benutzer:innen sind alle Autor:innen und Leser:innen im PORTAL. Über die Benutzer API können sämtliche Informationen von Benutzer:innen ausgelesen oder manipuliert werden. Auch das Löschen von einzelnen Benutzer:innen ist über die API möglich. Wird ein:e Benutzer:in gelöscht, hat das auch das Löschen seiner bzw. ihrer veröffentlichten Inhalte zur Folge. Es ist daher sehr darauf zu achten, wer diesen Endpunkt bedient und wie.
GET
Get All Users by Filters
first_name
last_name
email
updated_since
registration_date_from
registration_date_to
enabled
locked
lock_state (available values: none, pending_approval, locked)
tags
user_ids
Get User Information by user_id
user_id
Get User Information by Authentication Token
Get All User Segments
Response
{
"total_results": 234,
"total_pages": 12,
"page": 1,
"page_size": 20,
"data": [
{
"embeds":{
"embedcode": {
"e3rux4b8nc0" {
"content": "<b>Bold</b>"
}
}
},
"id": "1",
"remote_id": {
"ssofact": "12345"
},
"first_name": "Max",
"last_name": "Mustermann",
"full_name": "Max Mustermann",
"credits": 132,
"group_ids": [
2,
3
],
"email": "max@mustermann.de",
"registration_date": "2015-03-07T03:00:00+00:00",
"last_login": "2019-03-07T13:00:00+00:00",
"user_type": "person",
"user_segment": "leserreporter",
"location_id": 17,
"static_tags": [
"commercial"
],
"avatar": {
"url": "https://example.com/resources/mediadb/user/2019/04/18/1/1_M.jpg",
"id": "12"
},
"wallpaper": {
"url": "https://example.com/resources/mediadb/user/2019/04/18/1/1_XL.jpg",
"id": "13"
},
"lock_state": "none",
"enabled": true,
"address": {
"street": "Example Street",
"street_number": "123",
"zipcode": "86159",
"city": "Augsburg",
"phone": "08212849204"
},
"biograpy": "[embedcode=e3rux4b8nc0][/embedcode]This is the example biography from Max Mustermann.",
"gender": "male",
"birthdate": "1977-03-07",
"tags": [
"Tagger",
"I'm a Tag"
]
}
]
}
Sofern ein GET -Aufruf mehr als 10.000 Treffer zurückgibt, wird ein 400-Fehler ausgegeben. In diesem Fall müssen die Ergebnisse mithilfe der Filter weiter eingeschränkt werden.
POST
Create User
PUT
Update User
DELETE
Delete User by ID
user_id
Request Body
{
"remote_id": {
"ssofact": "12345"
},
"first_name": "Max",
"last_name": "Mustermann",
"credits": 1,
"group_ids": [
2,
3
],
"email": "max@mustermann.de",
"plaintext_password": "Password123!",
"last_login": "2019-03-07T13:00:00+00:00",
"user_type": "person",
"user_segment": "leserreporter",
"location_id": 17,
"static_tags": [
"commercial"
],
"lock_state": "none",
"enabled": true,
"address": {
"street": "Example Street",
"street_number": "123",
"zipcode": "86159",
"city": "Augsburg",
"phone": "08212849204"
},
"biograpy": "This is the example biography from Max Mustermann.",
"gender": "male",
"birthdate": "1977-03-07",
"tags": [
"Tagger",
"I'm a Tag"
]
}
HTTP Status Codes
200 - Success Alles hat wie erwartet funktioniert 201 - User Successfully Created 204 - User Successfully Updated / Deleted 400 - Bad Reqest Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body. 404 - User Not Found Der User scheint nicht zu existieren
Verfügbare Endpunkte für User Groups
Benutzergruppen können im PORTAL über die Berechtigungsgruppenverwaltung angelegt werden. Der API Endpunkt dient dazu, die IDs von Benutzergruppen zu ermitteln und diese dem User zuzuweisen.
GET
Get All User Groups
Get User Group Information by group_id
group_id
Response
[
{
"id": 1,
"name": "Super Admin",
"description": "Super Admins have access to everything on the Portal."
}
]
HTTP Status Codes
200 - Success Alles hat wie erwartet funktioniert 400 - Bad Reqest Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body. 404 - Group Not Found Die Gruppe scheint nicht zu existieren
Verfügbare Endpunkte für User Images
Die Profilseite eines bzw. einer Benutzer:in enthält sowohl ein Profilbild als auch ein Panorama-Wallpaper. Über folgende Endpunkte können die Bilder gelesen und gelöscht oder neue Bilder, z. B. von externen Quellen, ins PORTAL geladen werden.
GET
Get User Avatar by user_id
user_id
Get User Wallpaper by user_id
user_id
Response
{
"id": "1",
"url_set": {
"NATIVE": "https://www.example.com/resources/mediadb/article/2019/03/27/1/1_NATIVE.jpg",
"T": "https://www.example.com/resources/mediadb/article/2019/03/27/1/1_T.jpg",
"XS": "https://www.example.com/resources/mediadb/article/2019/03/27/1/1_XS.jpg",
"S": "https://www.example.com/resources/mediadb/article/2019/03/27/1/1_S.jpg",
"M": "https://www.example.com/resources/mediadb/article/2019/03/27/1/1_M.jpg",
"L": "https://www.example.com/resources/mediadb/article/2019/03/27/1/1_L.jpg",
"XL": "https://www.example.com/resources/mediadb/article/2019/03/27/1/1_XL.jpg",
"XXL": "https://www.example.com/resources/mediadb/article/2019/03/27/1/1_XXL.jpg"
},
"user_id": 1,
"created": "2019-03-07T00:00:00+00:00",
"modified": "2019-03-07T00:00:00+00:00",
"focus_x": "2",
"focus_y": "3"
}
POST
Upload User Avatar for a specific User
user_id
Upload User Wallpaper for a specific User
user_id
DELETE
Delete User Avatar by user_id
user_id
Delete User Wallpaper by user_id
user_id
Request Body
{
"url": "https://www.example.com/resources/mediadb/article/2019/03/04/1/1_XL.jpg",
"creation_date": "2019-03-07T00:00:00+00:00",
"focus_x": "2",
"focus_y": "3"
}
HTTP Status Codes
200 - Success Alles hat wie erwartet funktioniert 201 - User Avatar / Wallpaper successfully created 204 - User Avatar / Wallpaper successfully deleted 400 - Bad Reqest Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body. 404 - User Not Found Der User scheint nicht zu existieren
Trouble Shooting bei HTTP Status Codes
Verwandte Themen
Disclaimer
Für die vorliegende Systemübersicht/Publikation behalten wir uns alle Rechte vor. Nachdruck, Vervielfältigung und Verbreitung (auch auszugsweise) ist nur mit schriftlicher Genehmigung der PEIQ Publishing GmbH & Co. KG erlaubt. Wir behalten uns vor, die Systemübersicht/Publikation jederzeit ohne vorherige Ankündigung zu ändern und/oder zu erweitern. Die vorliegenden Angaben dienen lediglich Informationszwecken. Die PEIQ Publishing GmbH & Co. KG übernimmt keinerlei Haftung und/oder Garantie für Fehler und/oder unvollständige Angaben in der Systemübersicht/Publikation, mit Ausnahme von vorsätzlich falschen oder arglistig verschwiegenen Angaben. Da unsere Software laufend weiter entwickelt wird, handelt es sich bei den vorliegenden nur um allgemeine Angaben. Es handelt sich weder um eine Zusicherung von Mindestvertragsinhalten, noch um Beschaffenheitsgarantien im Sinne des § 443 BGB.