Application Programming Interface (API)

11. Februar 2021
  • Doku

Einführung

Die REST-API von PitchYou ermöglicht es Drittsystemen, den WhatsApp-Kanal von PitchYou für Bewerbungen zu nutzen und die über diesen Kanal generierten Bewerbungen in der eigenen Software zu überführen.

Die technische Dokumentation der API finden Sie hier: https://api.pitchyou.de/docs

 

Unterstützte Prozesse

(A) Integration von PitchYou-Interviews als Bewerbungskanal in die Stellenausschreibungen des ATS

  1. PitchYou stellt Interview-Templates für verschiedene Jobs zur Verfügung. Diese Templates legen fest, wie die WhatsApp-Bewerbung abläuft, welche Fragen gestellt und welche Medien (Bild, Video, Dokumente) abgefragt werden.
  2. Das anzubindende ATS kann die Liste der Interview-Templates über die API abrufen und
  3. dem Benutzer des ATS bei Stellenausschreibungen die Liste der Interview-Templates zur Auswahl anbieten
  4. Somit ist definiert welches Interview bei einer Bewerbung über WhatsApp für eine konkrete Stellenausschreibung angesprungen werden muss
  5. Das anzubindende ATS muss die Möglichkeit zur Bewerbung über WhatsApp über einen Button oder Link in seinen Stellenausschreibungen zur Verfügung stellen

(B) Integration von Bewerbungen, die über den PitchYou-Bewerbungskanal eingegangen sind

  1. Ein Bewerber/eine Bewerberin klickt die PitchYou-URL (Jetzt per WhatsApp bewerben) in der Stellenausschreibung
  2. Er/Sie wird auf die PitchYou-Disclaimer-Seite weitergeleitet und startet dort das Bewerbung-Interview per WhatsApp
  3. Der Bewerber/die Bewerberin beendet das Interview. Nun liegt eine abgeschlossene Bewerbung vor.
  4. Das anzubindende ATS kann über die API die Bewerbungen (Interview-Inhalte mit Medien-Dateien) abholen und
  5. diese Bewerbungen den Benutzern des ATS (Recruitern) zur Verfügung stellen und
  6. den internen Bewerbungsprozess im ATS durchlaufen

Autorisierung und Aufrufe

Alle API-Aufrufe sind als REST-Methoden implementieret, die über die URL https://api.pitchyou.de erreichbar sind.

Es wird OAuth2 Autorisierung verwendet. Für die Aufrufe von API-Methoden ist ein access token notwendig. Dieser token wird über die API-Methode (POST): /token abgerufen. Für den Abruf sind eine client_id und ein client_secret notwendig. Beide Parameter werden dem Nutzer der API durch PitchYou zur Verfügung gestellt.

 

 

Integration des PitchYou-Bewerberkanals in die Stellenausschreibungen

Abruf der zu Verfügung stehenden Interviews:

(GET) /api/jobtemplates/v1/gettemplates liefert eine Liste (Array) aller zur Verfügung stehender Interview-Templates.

Im angebundenen ATS können diese Interview-Templates (z. B. als Dropdown-Liste) bei der Ausschreibung von Stellen angeboten werden, um für jede Ausschreibung festzulegen, welches Interview bei einer späteren Bewerbung über WhatsApp durchlaufen werden soll.

Der Schlüssel für ein Interview-Template ist dabei templateKey die Beschreibung findet sich in description.

Die Stellenausschreibung kann nun seitens des angebundenen ATS für eine spätere Bewerbung per WhatsApp vorbereitet werden. Dazu ist es notwendig einen entsprechenden Button oder Link in die Stellenausschreibung aufzunehmen, der zur Nutzung der WhatsApp-Bewerbung motiviert. "Jetzt einfach per WhatsApp bewerben". Es ist hilfreich den Link oder Button mit einem WhatsApp-Logo (Wiedererkennungswert) zu versehen.

Technisch muss eine URL zum Absprung auf das PitchYou-Interview hinterlegt werden:

https://{client_id}.pitchyou.de/go/{external_id}?jkey={templateKey}

client_id = Die eindeutige Bezeichnung des Mandanten (siehe Token Erzeugung)

external_id = Ein beliebiger Job-Identifier aus dem angebundenen ATS. Es kann sich um eine Job-Id evtl. verbunden mit einer Kampagnen Id handeln.

templateKey (optional) = Gibt an welches Interview-Template für den Job zu benutzen ist. Wenn dieser Parameter fehlt, wird das Standard-Interview für den Mandanten ausgeliefert.

 

Integration der über PitchYou eingegangenen Bewerbungen in das ATS

Wenn der Bewerber ein PitchYou-Interview abgeschlossen hat, liegt eine neue Bewerbung vor.

Bewerbungen können über die API-Methode: (GET) /api/applicant/v1/profiles abgerufen werden.

Die Methode liefert eine Liste (Array) von Bewerberprofilen zurück.

  • Jede Bewerbung ist eindeutig durch die profileId identifiziert.
  • Die Interview-Fragen und Antworten finden sich im Array steps wieder
  • Jeder step kann Medien-Daten (Bild, Dokument, Video) enthalten
  • Jede Bewerbung kann weitere Medien-Daten in den Felder cv und profileImage enthalten.

Wie werden Mediendaten abgerufen?

Über die Methode  (GET) /api/media/v1/download/{profileId}/{mediaId} können Dateien heruntergeladen und im angebundenen ATS zur Verfügung gestellt werden.

Zurück

Navigation Schließen Suche E-Mail Telefon Kontakt Pfeil nach unten Pfeil nach oben Pfeil nach links Pfeil nach rechts Standort Externer Link Startseite Facebook LinkedIn Instagram