Status

colour	Purple
title	zur abnahme

Former user (Deleted)

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

Cloud Connect API

Info

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.

Produkt (Label)

portal

Übergeordnetes Modul (Label)

API, Benutzer und Gruppen

Inhaltsverzeichnis

Funktionalitäten der Benutzer API

Anlegen und Editieren von Benutzer:innen & Gruppen
Löschen und Auslesen von Benutzer:innen & Gruppen

Inhaltsverzeichnis

Expand

title	Inhaltsverzeichnis anzeigen

Table of Contents

maxLevel	4

Interne Beschreibung

Basis URL

Code Block

language	html

https://yourdomain.com/api/v2/users

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 Autoren Autor:innen und Leser:innen im PortalPORTAL. Über die Benutzer - API können sämtliche Informationen von Benutzern Benutzer:innen ausgelesen oder manipuliert werden. Auch das Löschen von einzelnen Nutzern Benutzer:innen ist über die API möglich. Wird ein Nutzer :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.

Status

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

Code Block

language	json

{
  "total_results": 234,
  "total_pages": 12,
  "page": 1,
  "page_size": 20,
  "data": [
    {
      "idembeds":{
"1",        "remote_idembedcode": {
        "ssofact":  "12345e3rux4b8nc0" {
     },       "first_namecontent": "Max<b>Bold</b>",
      "last_name": "Mustermann",   }
   "full_name": "Max Mustermann",
     }
     "credits": 132},
      "group_idsid": ["1",
      "remote_id": {
2,         3"ssofact": "12345"
      ]},
      "emailfirst_name": "max@mustermann.deMax",
      "registrationlast_datename": "2015-03-07T03:00:00+00:00Mustermann",
      "lastfull_loginname": "2019-03-07T13:00:00+00:00Max Mustermann",
      "user_typecredits": "person"132,
      "usergroup_segmentids": "leserreporter", [
        "location_id": 172,
      "static_tags": [ 3
      ],
"commercial"       ]"email": "max@mustermann.de",
      "avatarregistration_date": {
"2015-03-07T03:00:00+00:00",
       "urllast_login": "https://example.com/resources/mediadb/user/2019/04/18/1/1_M.jpg2019-03-07T13:00:00+00:00",
        "iduser_type": "12"
      }person",
      "wallpaperuser_segment": {"leserreporter",
        "urllocation_id": "https://example.com/resources/mediadb/user/2019/04/18/1/1_XL.jpg",
 17,
      "idstatic_tags": "13"[
      },       "lock_state": "none","commercial"
       "enabled": true],
      "addressavatar": {
        "streeturl": "Example Streethttps://example.com/resources/mediadb/user/2019/04/18/1/1_M.jpg",
        "street_numberid": "123",12"
      },
      "zipcodewallpaper": "86159",{
        "cityurl": "Augsburghttps://example.com/resources/mediadb/user/2019/04/18/1/1_XL.jpg",
        "phoneid": "0821284920413"
      },
      "biograpylock_state": "none"This,
is the example biography from Max Mustermann.""enabled": true,
      "genderaddress": "male", {
        "birthdatestreet": "1977-03-07Example Street",
        "tagsstreet_number": ["123",
        "zipcode": "Tagger86159",
        "I'm a Tag"
city": "Augsburg",
        "phone": "08212849204"
     ] },
   }   "biograpy": "[embedcode=e3rux4b8nc0]
}

Status

colour	Green
title	POST

Create User

Status

colour	Yellow
title	PUT

Update User

Status

colour	Red
title	DELETE

Delete User by ID
- user_id

Request Body

Code Block

language	json

{
  "remote_id": {[/embedcode]This is the example biography from Max Mustermann.",
      "ssofactgender": "12345male",
   },   "first_namebirthdate": "Max1977-03-07",
  "last_name": "Mustermann",   "creditstags": 1,[
  "group_ids": [     2"Tagger",
    3   ], "I'm a "emailTag":
"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]
}

Sofern ein

Status

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

Status

colour	Green
title	POST

Create User

Status

colour	Yellow
title	PUT

Update User

Status

colour	Red
title	DELETE

Delete User by ID
- user_id

Request Body

Code Block

language	json

{
  "remote_id": {
    "ssofact": "12345"
  },
  "first_name": "Max",
  "enabledlast_name": true"Mustermann",
  "addresscredits": {
 1,
  "streetgroup_ids": "Example[
Street",     "street_number": "123",2,
    3
 "zipcode": "86159" ],
    "cityemail": "Augsburgmax@mustermann.de",
    "phoneplaintext_password": "08212849204"
  }Password123!",
  "biograpylast_login": "This is the example biography from Max Mustermann.2019-03-07T13:00:00+00:00",
  "user_type": "person",
  "genderuser_segment": "maleleserreporter",
  "birthdatelocation_id": "1977-03-07"17,
  "static_tags": [
    "Taggercommercial",
  ],
  "I'm a Tag"lock_state": "none",
  ]
}

HTTP Status Codes

Code Block200 - Success

"enabled": true,
  "address": {
    "street": "Example

Alles

Street",

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.

Status

colour	Blue
title	GET

Get All User Groups
Get User Group Information by group_id
- group_id

Response

Code Block

language	json

[
  {
    "id": 1,
    "name": "Super Admin",
    "description": "Super Admins have access to everything on the Portal."
  }
]

HTTP Status Codes

Code Block

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

 "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

Code Block

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.

Status

colour	Blue
title	getGET

Get All User Avatar by user_id
- user_id
Groups
Get User Wallpaper Group Information by usergroup_id
- usergroup_id

Response

Code Block

language	json

[
  {
    "id": "1",
    "url_setname": { "Super Admin",
    "NATIVEdescription": "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://Super Admins have access to everything on the Portal."
  }
]

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.

Status

colour	Blue
title	get

Get User Avatar by user_id
- user_id
Get User Wallpaper by user_id
- user_id

Response

Code Block

language	json

{
  "id": "1",
  "url_set": {
    "NATIVE": "https://www.example.com/resources/mediadb/article/2019/03/27/1/1_XSNATIVE.jpg",
    "ST": "https://www.example.com/resources/mediadb/article/2019/03/27/1/1_ST.jpg",
    "MXS": "https://www.example.com/resources/mediadb/article/2019/03/27/1/1_MXS.jpg",
    "LS": "https://www.example.com/resources/mediadb/article/2019/03/27/1/1_LS.jpg",
    "XLM": "https://www.example.com/resources/mediadb/article/2019/03/27/1/1_XLM.jpg",
    "XXLL": "https://www.example.com/resources/mediadb/article/2019/03/27/1/1_XXLL.jpg",
  },   "user_idXL": 1,
  "created": "2019-03-07T00:00:00+00:00"https://www.example.com/resources/mediadb/article/2019/03/27/1/1_XL.jpg",
    "modifiedXXL": "2019-03-07T00:00:00+00:00"https://www.example.com/resources/mediadb/article/2019/03/27/1/1_XXL.jpg"
  },
  "focususer_xid": "2"1,
  "focus_y": "3"
}

Status

colour	Green
title	POST

Upload User Avatar for a specific User
- user_id
Upload User Wallpaper for a specific User
- user_id

Status

colour	Red
title	delete

Delete User Avatar by user_id
- user_id
Delete User Wallpaper by user_id
- user_id

Request Body

Code Block

language	json

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

Code Block

language	html

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

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 AnbindungEntwicklungsverlauf

Entwicklungsverlauf

Links zu Issues, Tickets, etc. Neueste zuerst:

Epics

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

Modul im Einsatz bei

[ALLIN] (all-in.de)

Status

colour	Green
title	Online (V2)

[WVW] (lokalkompass.de)

Status

colour	Green
title	Online (V2)

Alte Version (V1) genutzt von:

[KIRCHENZTG] (meine-kirchenzeitung.de)
Status
colour Yellow
title Version V1
[SIEGEN] (siegener-zeitung.de)
Status
colour Yellow
title Version V1

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

Note
Beschreibt in wenigen Sätzen die Ziele bzw. Vorteile des Moduls / Features sowie als Stichwortliste dessen Leistungsumfang. Die Allgemeine Beschreibung ist als Einstieg für den Kunden zu verstehen und beantwortet folgende Fragen: Warum brauche ich das? Was kann das?

Excerpt

Details
Status
colour Green
title extern

Note
Externe Produktdokumentation für die Kunden (Customer Success): Inhalt der aktuell FAQ benannten Dokumente, aber nicht als Frage-Antwort, sondern einfach als Dokumentation für den (potenziellen) Kunden (ohne kritische interne Hinweise, ohne Aufwände, vor allem ohne Links auf die interne CORE-Umgebung).

Excerpt

Release-Notes
Status
colour Green
title extern

Excerpt

Monat 202X - Zusammenfassung

Text

Excerpt

Monat 202X - Zusammenfassung

Text

Anleitung zum Setup
Status
colour Green
title extern

Excerpt

Historie

change-history

created": "2019-03-07T00:00:00+00:00",
  "modified": "2019-03-07T00:00:00+00:00",
  "focus_x": "2",
  "focus_y": "3"
}

Status

colour	Green
title	POST

Upload User Avatar for a specific User
- user_id
Upload User Wallpaper for a specific User
- user_id

Status

colour	Red
title	delete

Delete User Avatar by user_id
- user_id
Delete User Wallpaper by user_id
- user_id

Request Body

Code Block

language	json

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

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Zusammenfassung

Inhaltsverzeichnis

Inhaltsverzeichnis

Interne Beschreibung

Basis URL

Grundlegendes zur Benutzer API

Verfügbare Endpunkte für User

Response

Request Body

Request Body

HTTP Status Codes

Verfügbare Endpunkte für User Groups

Response

HTTP Status Codes

Verfügbare Endpunkte für User Images

HTTP Status Codes

Verfügbare Endpunkte für User Groups

Response

Verfügbare Endpunkte für User Images

Response

Request Body

HTTP Status Codes

Setup & Konfiguration

Konfigurationsparameter

Bekannte Einschränkungen

Entwicklungsverlauf

Links zu Issues, Tickets, etc. Neueste zuerst:

Epics

Modul im Einsatz bei

Alte Version (V1) genutzt von:

Verwandte Themen

Ansprechpartner

Teil 2 - EXTERN für Kunden & Interessenten StatuscolourGreentitleextern

Allgemeine Beschreibung StatuscolourGreentitleextern

Details StatuscolourGreentitleextern

Release-Notes StatuscolourGreentitleextern

Monat 202X - Zusammenfassung

Monat 202X - Zusammenfassung

Anleitung zum Setup StatuscolourGreentitleextern

Historie

Request Body

Trouble Shooting bei HTTP Status Codes

400 - Bad Request

404 - Not Found

Verwandte Themen

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

Anleitung zum Setup
Status
colour Green
title extern

`400` - Bad Request

`404` - Not Found