Stellenmarkt API

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

- 1.1 Grundsätzliches zur Stellenanzeigen API
- 1.2 Verfügbare Endpunkte für Job Ads
  - 1.2.1 Response
  - 1.2.2 Request Body
- 1.3 Verfügbare Endpunkte für Job Ad Categories
  - 1.3.1 Response
- 1.4 Verfügbare Endpunkte für Job Ad Images
  - 1.4.1 Response
  - 1.4.2 Request Body
2 Trouble Shooting bei HTTP Status Codes
- 2.1 400 - Bad Request
- 2.2 404 - Not Found
3 Verwandte Themen

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