REST-API: Anbindungsmöglichkeiten in der Bewerbungsverwaltung
In diesem Themendokument werden die Anbindungsmöglichkeiten in der Bewerbungsverwaltung über die REST-API (Representational State Transfer Application Programming Interface) sowie die Optionen mit unserem Partnerunternehmen syreta GmbH beschrieben.
Allgemeines
Die Anbindung über die REST-API bietet die Möglichkeit, Bewerbungsdaten in die BMD Software zu importieren sowie Jobinformationen aus der BMD Software zu exportieren. Bewerbungen, die über eine Bewerbungsmaske übermittelt werden, können über die REST-API in die BMD Software importiert werden. Ebenso können Jobs, die in den PI Jobs verwendet werden, über die REST-API veröffentlicht und angepasst werden. Um mit diesen Anbindungsmöglichkeiten zu arbeiten, stehen zwei Optionen zur Verfügung:
- Kundenseitige Bereitstellung der Bewerbungsmaske und Einrichtung der REST-API-Schnittstelle
- syreta GmbH stellt die Bewerbungsmaske und die Einrichtung der REST-API-Schnittstelle zur Verfügung.
Hinweis
 | Die Anbindung über die REST-API stellt keine offene Schnittstelle dar. |
Bewerbungsdaten, die über die Bewerbungsmaske abgesendet werden, können im PI Bewerbungsimport unter PI → Bewerber → Bewerbungsimport importiert werden. Sowohl Bewerbungsdaten als auch Bewerbungsdokumente können nach dem Import weiter verwaltet werden.
Voraussetzungen für die Anbindung via REST-API
Lizenz
Um die Anbindung mit der REST-API nutzen zu können, muss die Lizenz "BMD Web-Onlinebewerbung Frontend" erworben werden. Weitere Informationen finden Sie unter Lizenzen kaufen.
REST-API-Anbindung mit eigenem Bewerbungsformular
Für die Anbindung über die REST-API und ein eigenes Bewerbungsformular sind bestimmte technische Voraussetzungen erforderlich:
- Erwerb der notwendigen Lizenz
- Öffentliche URL, unter welcher der BMD Webserver erreichbar ist
- Eigener BMD User für die REST-API-Anbindung und Zordnung zu einem fiktiven Mitarbeiter (z. B. "API_Bewerbung")
- Link zur BMD Web-Adresse
- Token (wird beim Kauf der Lizenz vergeben)
- API-Nutzungsvertrag
REST-API-Anbindung mit syreta
Um die Schnittstellenlösung über syreta nutzen zu können, sind seitens BMD folgende technische Voraussetzungen erforderlich: Zum einen muss die entsprechende Lizenz erworben werden, zum anderen ist ein eigener BMD User (z. B. APIsyreta) notwendig, der einem fiktiven Mitarbeiter zugeordnet wird, sowie der Link zur BMD Webadresse. Alle Voraussetzungen seitens syreta sind direkt mit dem Anbieter zu klären.
- Erwerb der notwendigen Lizenz
- Erreichbarkeit des Webservers von extern
- Eigener BMD User für die REST-API-Anbindung und Zordnung zu einem fiktiven Mitarbeiter (z. B. API_syreta)
- Link zur BMD Web-Adresse
- Alle Voraussetzungen seitens syreta sind direkt mit dem Anbieter zu klären.
Hinweis
| Alle Voraussetzungen seitens syreta sind direkt mit dem Anbieter zu klären. Passwortänderung Bei Passwortänderungen des API-Users muss syreta umgehend über die Änderung informiert werden. |
Allgemeine Systemeinstellung und Berechtigungen
Systemeinstellungen
Zuweisung des API-Users zur Hauptfirma
Der neu angelegte User "API_Bewerbung" oder "API_syreta" für die REST-API-Anbindung muss der Hauptfirma zugewiesen werden. Dies erfolgt bei bestehender Firmengruppe in die Hauptfirma der Gruppe oder, falls keine Firmengruppe vorhanden ist, in jene Firma, in der das PI in Verwendung ist. Hierzu ist es erforderlich, die Firma im CRM Parameter "Eigene Firma" des API-Users zu hinterlegen. Der CRM Parameter kann unter CRM → Stammdaten → Einstellungen → CRM Parameter → CRM → Allgemein → "Eigene Firma" gesetzt werden.
Bewerbungsimportparameter
Um Bewerbungen importieren zu können, müssen die jeweiligen Einstellungen in den Bewerbungsimportparametern vorgenommen werden. Dies umfasst unter anderem die Einstellungen für das DMS wie Archiv, Dateigröße, Dateitypen und Dokumentenkategorie sowie die Einstellungen für das Bewerbungsfoto wie Fotokategorie und Dateitypen. Alle Informationen können in der BMD Hilfe unter Bewerbungsimportparameter nachgelesen werden.
Festlegung der Feldauswahl
Es muss sichergestellt sein, dass alle für den Datenaustausch erforderlichen Felder auch beim Job selbst verfügbar sind, da nicht alle Felder in der Standardfeldauswahl enthalten sind.
Als Beispiel dienen folgende Felder, die im Standard nicht enthalten sind:
- Postleitzahl
- Ort
- Benefits
- Anforderungen
- Jobtext
- Freifeldtext
Ist die Feldauswahl dementsprechend angepasst worden, sind die Felder im Job sichtbar.
Anpassung des Jobtextes
Um die Jobbeschreibung dem Bewerbungsformular in übersichtlicher Form zur Verfügung zu stellen, ist es notwendig, den Jobtext in der BMD Software anzupassen.
Aufzählungen im Jobtext können wie in diesem Beispiel dargestellt werden:
In dieser verantwortungsvollen Position unterstützen Sie die Geschäftsführung im operativen und strategischen Tagesgeschäft und tragen wesentlich zu reibungslosen Abläufen bei.
<br><br>
<ul>
<li>Organisation und Koordination von Terminen, Meetings und Geschäftsreisen
<li>Vor- und Nachbereitung von Besprechungen inklusive Protokollführung
<li>Erstellung von Präsentationen, Auswertungen und Entscheidungsvorlagen
<li>Selbstständige Bearbeitung von Projekten und Sonderaufgaben
<li>Kommunikation mit internen und externen Ansprechpartnern
<li>Unterstützung bei administrativen und organisatorischen Aufgaben
</ul>
<br><br>
<ul>
<li>Organisation und Koordination von Terminen, Meetings und Geschäftsreisen
<li>Vor- und Nachbereitung von Besprechungen inklusive Protokollführung
<li>Erstellung von Präsentationen, Auswertungen und Entscheidungsvorlagen
<li>Selbstständige Bearbeitung von Projekten und Sonderaufgaben
<li>Kommunikation mit internen und externen Ansprechpartnern
<li>Unterstützung bei administrativen und organisatorischen Aufgaben
</ul>
Die verwendeten Abkürzungen haben folgende Bedeutung:
- BR = Zeilenumbruch im HTML
- UL = Punkteliste
- OL = Listen mit 1., 2., 3.
- LI = Listeneintrag
Hinweis
| Bei den Anpassungen der Jobbeschreibung handelt es sich nicht um BMD-spezifische Vorgaben, sondern um allgemeine Vorgaben der "Text/Content Formatting Guidelines". |
Berechtigungen für den API-User
Allgemeine Berechtigung
Wenn die Möglichkeit besteht, empfehlen wir, dem API-User die Berechtigung "*ALL" zu erteilen. Alternativ kann dem API-User auch eine eigene Berechtigungsgruppe mit PI- und DMS-Rechten zugeordnet werden.
Berechtigungen für die jeweiligen Jobs
Es ist notwendig, den fiktiven Mitarbeiter in den Berechtigungen für Personalinformation zu den weiteren Mitarbeitern hinzuzufügen. Dies kann unter PI → Stammdaten → Einstellungen → Berechtigungen für Personalinformation → Funktionen → "Vorlage speichern" für den jeweiligen Job vorgenommen werden.
Datenbesitzergruppen für den API-User
Wenn Datenbesitzergruppen für die Bereiche Firma, Archiv, Dokumentenkategorien (Bewerbungsimportparameter) und Jobs vorhanden sind, müssen diese auch für den API-User berücksichtigt werden.
Karriereportal
Wird die Anbindung über syreta genutzt, muss dafür in der BMD Software ein Karriereportal angelegt werden. Das Fenster zur Neuanlage kann unter PI → Stammdaten → Einstellungen → "Karriereportale" aufgerufen werden.
Mittels Neuanlage kann ein Karriereportal für syreta erstellt werden:
Ebenso müssen die jeweiligen Jobs dem Karriereportal zugeordnet werden:
Die Zuordnung zu einem Karriereportal kann auch direkt beim Job über die entsprechende Funktion unter Fenstermenü → Funktionen → Job → "Karriereportal zuordnen" vorgenommen werden.
Hinweis
| Wird eine REST-API-Anbindung ohne syreta verwendet, ist die Anlage eines Karriereportals nicht erforderlich. Die Übertragung der Jobs erfolgt durch das Setzen des Kennzeichens im Feld "Onlinebewerbung" beim jeweiligen Job. |
Schnittstellenbeschreibung
Die Beschreibung der Schnittstelle erfolgt durch die Swagger-Dokumentation (OpenAPI-Dokumentation). Die Beschreibung der REST-API ist unter https://asp.bmd.at/bmdweb233864/bmdweb.dll/files/swagDoc/index_redocly.html zu finden.
Wählt man in der Swagger-Dokumentation "Human Capital Management" und "Job", werden die erforderlichen Informationen sowie die verfügbaren Felder angezeigt.
Import von Onlinebewerbungen via REST-API
Für den Import von Onlinebewerbungen wird die Request-Methode "POST" mit dem Request-Pfad "job/applicant" verwendet.
Beispiel
 | Felder, die für den Import einer Bewerbung in die BMD Software benötigt werden, sind in der Swagger-Dokumentation beschrieben. Anbei ein simples Beispiel für den Import von Firmennummer, Job, Vorname und Nachname. MCA_ASR_FIRMENNR=1 (Jene Firma, auf welcher der Job angelegt worden ist und auf welcher die Bewerbung importiert wird.) MCA_ASR_AUSSCHREIBUNGSNR=5 (Nummer des Jobs) MCA_OBP_NAME (Nachname) MCA_OBP_VORNAME (Vorname) Alle weiteren Informationen zu den verfügbaren Felder finden Sie in der Swagger-Dokumentation. |
Import von Dokumenten zur Onlinebewerbung via REST-API
Für den Import von Bewerbungsdokumenten wird die Request-Methode "POST" mit dem Request-Pfad "job/document" verwendet.
Hinweis
| Die Prüfung der importierten Dokumente erfolgt gemäß den Einstellungen in den PI Bewerbungsimportparametern. |
Export von Jobs via REST-API
Für den Export der verwendeten Jobs wird die Request-Methode "GET" mit dem Request-Pfad "job/(Standard-Get)" verwendet.
Export der Jobliste via REST-API
Für den Export der Jobliste wird die Request-Methode "GET" mit dem Request-Pfad "job/joblist" verwendet.
Löschen von Jobs via REST-API
Wenn man Jobs löschen möchte, die bereits vergeben worden sind, verwendet man die Request-Methode "DEL" mit dem Request-Pfad "job/(Standard-Delete)".
Problemlösungen
Problem | Lösung |
Lizenz nicht vorhanden | Fehlende Lizenz eintragen (BMD Web-Onlinebewerbung Frontend) |
API liefert Meldung "no Portal found" | Karriereportal für syreta wird nicht gefunden.
|
API liefert Fehler "Timeout Request" | Webserver ist von außen nicht erreichbar.
|
API liefert Fehler 404 | URL, die an syreta übermittelt worden ist, ist nicht korrekt.
|
API liefert Fehler 401 "Session ungültig" | Token, der von syreta an den Webserver geschickt wird, ist nicht korrekt.
|
API liefert bei Dokumenten und Fotos einen Code 400 und/oder es werden Logdateien am Webserver geschrieben | Problem bei der Konfiguration des Webservers liegt vor. Termin mit BMD Technik notwendig. |
 |