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 Stellenmarkt API dient zum Auslesen, zur Erstellung und zum Updaten/Löschen von Stellenanzeigen.
Funktionalitäten der Stellenmarkt API
Auslesen von Stellenanzeigen
Erstellung von Stellenanzeigen
Updaten/Löschen von Stellenanzeigen
Inhaltsverzeichnis
Grundsätzliches zur Stellenanzeigen API
Das PORTAL unterscheidet bei Stellenanzeigen grundsätzlich zwischen:
Text Job Ad - Einer rein textbasierten Stellenanzeige
Link Job Ad - Einer Stellenanzeige mit einem weiterführenden Link auf externe Angebote
Advanced Job Ads - Einer gestalteten Formatanzeige inkl. Überschrift und Bildern
Die static_tags “special” und “featured” sind Merkmale, mit denen die Reihenfolge der Anzeigen auf einer Anzeigenübersichtsseite gesteuert werden können. Je nach Kundeneinstellung erscheint mit diesen Tags auch eine entsprechende Markierung an den Anzeigenteasern (z. B. Anbieter der Region).
Verfügbare Endpunkte für Job Ads
GET
Get All Job Ads by Filters
date_filter_type (Available values : created, updated)
date_start
date_end
status (Available values : notstarted, available, expired)
static_tags (Available Values: 'special', 'featured')
type (Available values : text, link, advanced)
location_ids
user_id
category_id
Get Job Ad by advert_id
advert_id
Response
[
{
"id": 1,
"title": "Job Advert 1",
"type": "text",
"url": "https://www.example.com/jobs/hannover/c-handwerk/link-advert4-lorem-ipsum-dolor-sit-amet-consetetur_j75",
"text": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam volu",
"contact": {
"phone": "+49 821 13751",
"email": "mustermann@example.com",
"website": "https://google.com"
},
"starts": "2019-03-07T00:00:00+00:00",
"ends": "2019-03-07T00:00:00+00:00",
"created": "2019-03-07T00:00:00+00:00",
"updated": "2019-03-09T02:00:00+00:00",
"static_tags": [
"special",
"featured"
],
"category_id": 8,
"user_id": 1,
"default_location_id": 1,
"location_ids": [
1,
2,
3,
4,
5
],
"thumbnail": {
"url": "https://www.example.com/resources/mediadb/jobad/2019/03/04/1/1_XL.jpg",
"id": "12"
}
}
]
POST
Create Advanced Job Ad
Create Link Job Ad
Create Text Job Ad
PUT
Update Advanced Job Ad
advert_id
Update Link Job Ad
advert_id
Update Text Job Ad
advert_id
DELETE
Delete Job Ad by advert_id
advert_id
Request Body
For Advanced Job Ad
{
"title": "Job Advert 3",
"text": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam volu",
"contact": {
"phone": "+49 821 13751",
"email": "mustermann@example.com",
"website": "https://google.com"
},
"created": "2019-02-01T00:00:00+00:00",
"starts": "2019-03-01T00:00:00+00:00",
"ends": "2019-03-07T00:00:00+00:00",
"static_tags": [
"special",
"featured"
],
"category_id": 1,
"user_id": 1,
"default_location_id": 1,
"location_ids": [
1,
2
]
}
For Link Job Ad
{
"title": "Job Advert 2",
"text": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam volu",
"url": "https://www.example.com/jobs/hannover/c-handwerk/link-advert4-lorem-ipsum-dolor-sit-amet-consetetur_j75",
"created": "2019-02-01T00:00:00+00:00",
"starts": "2019-03-01T00:00:00+00:00",
"ends": "2019-03-07T00:00:00+00:00",
"static_tags": [
"special",
"featured"
],
"category_id": 1,
"user_id": 1,
"default_location_id": 1,
"location_ids": [
1,
2
]
}
For Text Job Ad
{
"text": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam volu",
"created": "2019-02-01T00:00:00+00:00",
"starts": "2019-03-01T00:00:00+00:00",
"ends": "2019-03-07T00:00:00+00:00",
"static_tags": [
"special",
"featured"
],
"category_id": 1,
"user_id": 1,
"default_location_id": 1,
"location_ids": [
1,
2
]
}
Verfügbare Endpunkte für Job Ad Categories
Kategorien werden von PEIQ im Rahmen des Set-up oder während der Laufzeit eingepflegt. Sie können über diesen Endpunkt einfach ausgelesen und verwendet werden.
GET
Get All Job Ad Categories
Get Job Ad Category by category_id
category_id
Response
[
{
"id": "1",
"name": "Dienstleistung",
"name_norm": "dienstleistung"
}
]
Verfügbare Endpunkte für Job Ad Images
Dieser Endpunkt ermöglicht es Bilder an Anzeigen zu lesen oder auch hinzuzufügen (z. B. von einer externen Ressource oder aus einer Bildersammlung), zu updaten oder zu löschen. Mit dem Parameter caption kann eine Bildunterschrift vergeben werden. Der Parameter copyright befüllt die Information zu dem bzw. der Urheber:in.
GET
Get All Images of a specific Job Ad
advert_id
Get Job Ad Image by image_id
image_id
Response
[
{
"id": "1",
"url_set": {
"NATIVE": "https://www.example.com/resources/mediadb/jobad/2019/03/27/1/1_NATIVE.jpg",
"T": "https://www.example.com/resources/mediadb/jobad/2019/03/27/1/1_T.jpg",
"XS": "https://www.example.com/resources/mediadb/jobad/2019/03/27/1/1_XS.jpg",
"S": "https://www.example.com/resources/mediadb/jobad/2019/03/27/1/1_S.jpg",
"M": "https://www.example.com/resources/mediadb/jobad/2019/03/27/1/1_M.jpg",
"L": "https://www.example.com/resources/mediadb/jobad/2019/03/27/1/1_L.jpg",
"XL": "https://www.example.com/resources/mediadb/jobad/2019/03/27/1/1_XL.jpg",
"XXL": "https://www.example.com/resources/mediadb/jobad/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",
"caption": "Test Image Caption",
"copyright": "Test Image Copyright",
"focus_x": "2",
"focus_y": "3"
}
]
POST
Upload Images for a specific Advanced Job Ad
advert_id
Upload Images for a specific Link Job Ad
advert_id
PUT
Update Job Ad Image Meta Data
image_id
DELETE
Delete Job Ad Image by image_id
image_id
Request Body
[
{
"url": "https://www.example.com/resources/mediadb/jobad/2019/03/04/1/1_XL.jpg",
"user_id": 1,
"creation_date": "2019-03-07T00:00:00+00:00",
"caption": "Test Image Caption",
"copyright": "Test Image Copyright",
"focus_x": "2",
"focus_y": "3"
}
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.