Schnittstelle (API) zum Einspielen von Bewerbungen

Bewerbungen können über eine JSON-Schnittstelle in onboard eingespielt werden.

API-Endpunkt

Der Endpunkt ist über folgende URL erreichbar:

POST https://<Unternehmen>.onboard.org/exports/v2/applications

Header

• API-KEY: Verpflichtend für die Autorisierung. Sie erhalten den API-Key von unserem Support-Team auf Anfrage.
• Content-Type: application/json

Parameter

Alle Parameter müssen in einem Objekt namens „application“ einghüllt werden.

Erforderliche Parameter:

• first_name: Vorname
• last_name: Nachname
• email: gültige E-Mail-Adresse

Optionale Parameter:

• gender: Geschlecht. Wird dieser Wert nicht mitgeschickt, so wird der Standard-Wert unknown verwendet. Mögliche Werte:
  • unknown: nicht bekannt / nicht gesetzt
  • male: männlich
  • female: weiblich
  • diverse: divers
• language: Sprache im ISO 639-1-Format (z.B. „de“, „it“ oder „en“). Ist die Sprache beim Unternehmen nicht definiert, wird eine Standard-Sprache gesetzt (englisch oder die Hauptsprache vom Unternehmen).
• nationality: Nationalität als Land-ISO-Code (z.B. „IT“)
• birthdate: Geburtsdatum im Format YYYY-MM-DD
• birthplace: Geburtsort
• street: Straße
• street_number: Hausnummer
• zip_code: Postleitzahl
• city: Wohnort
• region: Region (z.B. Bezirk, Bundesland)
• country_code: Land des Wohnorts als Land-ISO-Code (z.B. „IT“)
• phone: Telefonnummer
• notes: Bewerbungstext / Anschreiben
• job_id: ID der Stellenanzeige. Die Bewerbung wird als Initiativbewerbung betrachtet, wenn keine job_id übergeben wird.
• campaign_id: ID der Kampagne, von der die Bewerbung eingegangen ist.
• cv_public_url: URL zum Lebenslauf. Die Datei wird von dieser URL heruntergeladen und in onboard gespeichert.
• photo_public_url: URL zum Foto. Die Datei wird von dieser URL heruntergeladen und in onboard gespeichert.
• video_public_url: URL zum Video. Die Datei wird von dieser URL heruntergeladen und in onboard gespeichert.
• file_1_public_url: URL zur Datei-1. Die Datei wird von dieser URL heruntergeladen und in onboard gespeichert.
• file_2_public_url: URL zur Datei-2. Die Datei wird von dieser URL heruntergeladen und in onboard gespeichert.
• file_3_public_url: URL zur Datei-3. Die Datei wird von dieser URL heruntergeladen und in onboard gespeichert.
• file_4_public_url: URL zur Datei-4. Die Datei wird von dieser URL heruntergeladen und in onboard gespeichert.
• file_5_public_url: URL zur Datei-5. Die Datei wird von dieser URL heruntergeladen und in onboard gespeichert.
• send_confirmation_email: Bestimmt, ob eine Bestätigungs-E-Mail von onboard an den Bewerber gesendet werden soll, wenn die Bewerbung erfolgreich in onboard eingegangen ist. Standard-Wert: false. Mögliche Werte:
  • true: Bestätigungsemail wird gesendet
  • false: Bestätigungsemail wird nicht gesendet
• accept_archivation: Bestimmt, ob die Bewerbung länger als der vordefinierte Zeitraum in onboard aufbewahrt werden darf. Standard-Wert: false. Mögliche Werte:
  • true: Bewerbung darf länger aufbewahrt werden
  • false: Bewerbung wird nicht länger aufbewahrt
• accept_business_group: Bestimmt, ob die Bewerbung innerhalb der Unternehmensgruppe geteilt werden darf. Standard-Wert: false.
  • true: Bewerbung darf an andere Unternehmen innerhalb der Gruppe weitergereicht werden
  • false: Bewerbung wird nicht innerhalb der Unternehmensgruppe weitergereicht

Beispiel (alle Parameter):

"application": {
  "first_name": "Max",
  "last_name": "Mustermann",
  "email": "max.mustermann@gmail.com",
  "gender": "male",
  "language": "de",
  "nationality": "IT",
  "birthdate": "Fri, 06 Dec 1991",
  "birthplace": "Meran",
  "street": "Dr. J. Köllensperger Straße",
  "street_number": "10/B",
  "zip_code": "39011",
  "city": "Lana",
  "region": "BZ",
  "country_code": "IT",
  "phone": "+39 123 123 1234",
  "notes": "Hiermit bewerbe ich mich um die Stelle XY.",
  "job_id": "RrB7LYD2",
  "campaign_id": "KRBbJBwN",
  "cv_public_url": "https://some.url/assets/cv",
  "photo_public_url": "https://some.url/assets/photo",
  "video_public_url": "https://some.url/assets/video",
  "file_1_public_url": "https://some.url/assets/file1",
  "file_2_public_url": "https://some.url/assets/file2",
  "file_3_public_url": "https://some.url/assets/file3",
  "file_4_public_url": "https://some.url/assets/file4",
  "file_5_public_url": "https://some.url/assets/file5",
  "send_confirmation_email": "false",
  "accept_archivation": "true",
  "accept_business_group": "true"
}

Antwort

Beispiel Erfolgsfall:

{
  "id": "b9d120fha",
  "email": "max.mustermann@gmail.com",
  "created_at": "2023-08-28 00:00:00 UTC"
}

• id: ID der erstellten Bewerbung.
• email: E-Mail-Adresse des Bewerbers.
• created_at: Zeitpunkt, an dem die Bewerbung eingegangen ist.

HTTP-Status-Codes:

• 201: Bewerbung wurde erfolgreich eingespielt (Erfolgsfall).
• 401: Keine Berechtigung (ungültiger API-Key).
• 409: Für diese E-Mail-Adresse gibt es bereits eine Initiativbewerbung.
• 422: Fehlerhafte Parameter. Weitere Informationen im Antwort-Objekt.
• 500: Unerwarteter Fehler.

Wir empfehlen die Bewerbung von dem Abschicken zwischenzuspeichern und bei Fehlermeldungen entsprechend zu reagieren (z.B. erneuter Versuch, Anpassung Parameter, etc.).

Häufige Fragen

Die Schnittstelle liefert die Fehlermeldung, dass bereits eine Bewerbung mit derselben Mailadresse vorhanden ist. Woran liegt das?

Ein Spam-Schutz verhindert das mehrmalige Bewerben eines Kandidaten mit derselben Mailadresse für die gleiche Stellenanzeige bzw. die Initiativbewerbung innerhalb von 30 Tagen. Bewirbt sich eine Person mit derselben Mailadresse für zwei unterschiedliche Stellen, werden diese Bewerbungen regulär behandelt.