Hilfe - HR AdSys

Joblist API

: Zuletzt aktualisiert: 03. August 2022

Die Joblist API ist die Schnittstelle zu den Jobbörsen. Über sie erfolgt das Ausspielen der Anzeigen.

Diese Dokumentation beschreibt die Anbindung an unsere Joblist (Anzeigen Feed zum Auslesen der Stellenanzeigen).

Als registrierte Jobbörse erhalten Sie von uns auf Anfrage einen API Key, Ihr Schlüssel zu den Anzeigen Ihres Mediums.

Anbindung

Unsere Joblist API kann zwei Formate ausspielen: JSON und XML. Je nach, dem welches Format Sie benötigen, ist die Adresse (URL zur API) zu wählen.

URL Adresse / Ausgabeformat:

https://api.hr-adsys.de/v1/json/
https://api.hr-adsys.de/v1/xml/

IP Adresse:

Der Server hat die öffentliche IPv4 37.202.5.13 und IPv6 2a03:2a00:1200:0000:0001:0000:0000:3334

Authentifizierung

Zur Authentifizierung genügt das Anhängen des von uns ausgehändigten API Keys (Schlüssel zum Auslesen der Anzeigen).

Einfacher Aufruf:

https://api.hr-adsys.de/v1/xml/?key={API_Key}

Der API Key ist ein Base64-kodierter Schlüssel, der mit {API_Key} zu ersetzen ist.

Anzeigenstruktur

Unsere API kann beliebige W3C-valide XML- oder JSON-Schemas ausgeben. Der Aufbau der Struktur erfolgt durch uns. Lassen Sie uns hierzu Ihre Schema Definition zukommen und wir übernehmen den Aufbau für Sie.

Sie können aber auch unser Standardschema benutzen, falls Sie keine direkten Vorgaben haben.

Anzeigenschema: (Standardschema)

<?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" 
elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="Job">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="JobPositionPostingId" type="xs:string" />
        <xs:element name="ProductInformation">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="AdTerm" type="xs:string" />
              <xs:element name="ProductName" type="xs:string" />
              <xs:element name="Campus" type="xs:string" />
            </xs:sequence>
          </xs:complexType>
        </xs:element>
        <xs:element name="JobPositionPosting">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="HiringOrg">
                <xs:complexType>
                  <xs:sequence>
                    <xs:element name="HiringOrgName" type="xs:string" />
                    <xs:element name="HiringOrgId" type="xs:string" />
                    <xs:element name="HiringOrgLogo" type="xs:string" />
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
              <xs:element name="JobPositionInformation">
                <xs:complexType>
                  <xs:sequence>
                    <xs:element name="JobPositionLocation">
                      <xs:complexType>
                        <xs:sequence>
                          <xs:element name="PostalCode" type="xs:string" />
                          <xs:element name="Municipality" type="xs:string" />
                        </xs:sequence>
                      </xs:complexType>
                    </xs:element>
                    <xs:element name="JobPositionTitle" type="xs:string" />
                    <xs:element name="HTMLFullCode" type="xs:string" />
                    <xs:element name="Channel" type="xs:string" />
                    <xs:element name="AdLink" type="xs:string" />
                    <xs:element name="TrackingPixel" type="xs:string" />
                    <xs:element name="TrackingCode" type="xs:string" />
                    <xs:element name="ApplicationLink" type="xs:string" />
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
              <xs:element name="ExtendedJobBody">
                <xs:complexType>
                  <xs:sequence>
                    <xs:element name="JobId">
                      <xs:complexType>
                        <xs:sequence>
                          <xs:element name="ReferenceId" type="xs:string" />
                          <xs:element name="Kostenstelle" type="xs:string" />
                        </xs:sequence>
                      </xs:complexType>
                    </xs:element>
                    <xs:element name="ParentCorporation">
                      <xs:complexType>
                        <xs:sequence>
                          <xs:element name="ParentId" type="xs:string" />
                        </xs:sequence>
                      </xs:complexType>
                    </xs:element>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
            </xs:sequence>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

Joblist-Struktur

Unsere Joblist-Struktur erlaubt zwei Optionen, eine Anzeigenauflistung als „Linkliste“ oder „Eingebettet“. Bei „Eingebettet“ wird statt des Anzeigenlinks <xs:element name="Link" /> die komplette Anzeigenstruktur direkt in der Joblist gelistet.

Joblist-Schema als Linkliste:

<?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" 
           elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="Joblist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="Job">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="Link" />
            </xs:sequence>
            <xs:attribute name="uniqueJobId" type="xs:string" use="required" />
            <xs:attribute name="konzId" type="xs:string" use="required" />
            <xs:attribute name="companyId" type="xs:string" use="required" />
            <xs:attribute name="HiringOrgName" type="xs:string" use="required" />
            <xs:attribute name="ProductName" type="xs:string" use="required" />
            <xs:attribute name="adTerm" type="xs:string" use="required" />
            <xs:attribute name="parentId" type="xs:string" use="required" />
          </xs:complexType>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

Beispiel Joblist als Linkliste:

<?xml version="1.0" encoding="UTF-8"?>
<Joblist>
  <Job uniqueJobId="1" konzId="xxx" companyId="xxx" 
       HiringOrgName="xxx" ProductName="xxx" adTerm="xxx" parentId="xxx">
    <Link>https://api.hr-adsys.de/v1/xml/?key=xxx&id=1</Link>
  </Job>
  <Job uniqueJobId="2" konzId="xxx" companyId="xxx" 
       HiringOrgName="xxx" ProductName="xxx" adTerm="xxx" parentId="xxx">
    <Link>https://api.hr-adsys.de/v1/xml/?key=xxx&id=2</Link>
  </Job>
</Joblist>

Optionen

Über URL-Parameter können einige zusätzliche Optionen angewendet werden.

MIME-Type (Content-Type):

Der MIME-Type definiert das Ausgabeformat über den Response Header des Webservers. Unterstützt wird hierbei "text/plain" und "application/xml".

&format=text/plain

&format=application/xml
Formatierte Ausgabe:

Standardmäßig ist unsere API-Ausgabe komprimiert und minimiert, sodass sich die Seitenladegeschwindigkeit erhöht und die Ausführung beschleunigt wird. Die Ausgabe kann auch über „formatOutput“ formatiert erfolgen.

&formatOutput=1
Zählung der Anzeigen:

Über „count“ wird im root-Element der Joblist die Anzahl der Anzeigen mitgeliefert.

&count=1
```
<Joblist count="99">
```
Anzeigenauflistung:

Je nach Konfiguration werden Anzeigenknoten als tiefergehende XML Knoten verlinkt.
Über "incAds" können die Knoten eingebettet bereits in der Joblist ausgegeben werden.

&incAds=1

Hinweis: Die Abfrage nimmer hier mehr Zeit in Anspruch.
Joblist Attribute:

Über „joblistAttributes“ wird gesteuert ob Job spezifische Attribute in der Joblist beim Job-Knoten übertragen werden.

&joblistAttributes=0
```
<Job attr1="" attr2="etc.." >
```
Joblist/Job Knoten Benennung:

Über „nodeName[...]“ können sie direkt über die Abfrage den XML-Knotennamen <Joblist> und <Job> bestimmen und umbenennen.

&nodeName[Joblist]=ItemList&nodeName[Job]=Item
```
<Joblist>
    <Job>
        <Link>
```
Im Beispiel werden die XML-Knotennamen <Joblist> und <Job> umbenannt in <ItemList> und <Item>:
```
<ItemList>
    <Item>
        <Link>
```
Hinweis: Wir erlauben die Anpassung nur für die ersten beiden Ebenen. Der Aufbau der tieferen Struktur erfolgt durch uns. Lassen Sie uns hierzu Ihre Schema-Definition zukommen, wie im Punkt Anzeigen Struktur beschrieben.

Datenschutz

Bei der Auslieferung der Stellenanzeigen werden von uns Trackingtools und Trackingpixel in die Anzeige eingebaut. Dabei kommen Matomo sowie ein eigens entwickeltes Analysetool zum Einsatz. Beide eingesetzten Tools werden über unseren eigenen Server gehostet. Somit werden keine Daten an andere Webanalysedienste weitergeleitet. Wir verwenden die IP-Anonymisierung, somit wird die IP-Adresse der Bewerber, die die ausgelieferten Stellenanzeigen angezeigt bekommen und die mit dieser eventuell interagieren, nicht von unserem Webanalysetool gespeichert. Dadurch ist eine direkte Personenbeziehbarkeit ausgeschlossen. Wir nutzen die gesammelten Informationen, um die Nutzung und Interaktion der ausgelieferten Stellenanzeigen bei den jeweiligen Jobportalen auszuwerten und Ihnen entsprechende Reports zur Verfügung zu stellen.

War dieser Artikel hilfreich?

Index

Einleitung
Anbindung
Authentifizierung
Anzeigen Struktur
Joblist Struktur
Optionen
Datenschutz