Stafio API
Eine offene Schnittstelle, über die sich Ihre Website, Ihr Recruiting-System oder Ihr KI-Recruiter mit Stafio verbindet. Eine Adresse, ein Anfrageformat und immer nur die Daten Ihres Kontos.
POST https://<instance>/api/rpc/call
Content-Type: application/json
Content-Profile: api
Prefer: params=single-object
Authorization: Bearer <token>
{
"version": 8,
"func": "job.list",
"params": { "limit": 20, "offset": 0 }
}Wofür die API da ist
Was Sie über die Schnittstelle tun können
Stellenanzeigen auf Ihrer eigenen Website
Zeigen Sie Stellenanzeigen aus Stafio auf Ihrer Website an, und Bewerbungen gehen direkt ins Recruiting – ohne Exporte und ohne Bewerber von Hand anzulegen.
- Liste und Detail einer Stellenanzeige inklusive Beschreibung, Galerie und Video
- Eine Antwort auf eine Anzeige legt den Bewerber und seine Bewerbung an
- Der Lebenslauf wird an die Bewerbung angehängt und als Lebenslauf hinterlegt
Bewerber aus einem externen System
Bewerber kann auch ein anderes Tool sammeln – ein Recruiting-System, eine Karriere-Website oder ein KI-Recruiter, der Bewerber telefonisch vorqualifiziert. Sie werden an Stafio übergeben, und Recruiting, Onboarding, Schichten und Zeiterfassung laufen dann an einem Ort.
- Bewerberregistrierung auch ohne konkrete Stellenanzeige
- Die Notiz aus der Vorqualifizierung bleibt bei der Person
- Abgleich per E-Mail; die API lehnt doppelte Registrierungen ab
Ihr eigenes SMS-Gateway
Wenn Sie ein eigenes SMS-Gateway oder einen vergünstigten Tarif bei einem Mobilfunkanbieter haben, binden Sie es an Stafio an, und Nachrichten gehen darüber raus.
- Gateway-Konfiguration und Ausgabe der zu sendenden Nachrichten
- Zustellergebnisse werden an Stafio zurückgemeldet
- Eingehende Nachrichten und Anrufe im Personenprofil
Zugriff über ein eigenes Konto der Integration
Das Token wird nicht von Hand erstellt – die API stellt es gegen einen API-Schlüssel aus. Der Anbieter der Integration braucht nie das Passwort des Kontos, unter dem sie läuft.
- Jede Integration hat einen eigenen Nutzer mit API-Rolle
- Zugewiesene Arbeitsorte und Kostenstellen bestimmen den Datenumfang
- Ein API-Schlüssel wird durch Deaktivieren widerrufen, ohne das Passwort des Nutzers anzutasten
Wie die API funktioniert
Eine Adresse, eine Antwortstruktur
Sie rufen nicht je Funktion unterschiedliche Pfade auf – eine Anfrage geht immer an denselben Endpunkt, und der Body sagt, was zu tun ist. Der Body hat drei Felder: version (Version des API-Vertrags), func (logischer Funktionsname) und params. Der Header Prefer: params=single-object ist Pflicht.
Die Antwort hat immer dieselbe Struktur, unabhängig vom Ergebnis. Auch Fehler kommen in derselben Hülle zurück und werden am Feld ok und an der Struktur error unterschieden – der Client behandelt alles einheitlich und muss sich nicht mit verschiedenen Statuscodes befassen.
{
"ok": true,
"version": 8,
"func": "job.list",
"data": [ { "job_id": 1042, "name": "Lagermitarbeiter" } ],
"meta": { "row_count": 1 },
"error": null
}Funktionsübersicht
Was die Schnittstelle kann
| Funktion | Wofür sie da ist | Hauptparameter |
|---|---|---|
ping | Verfügbarkeitsprüfung | keine Parameter |
job.list | Liste der Stellenanzeigen | region_id, work_type_id, partner_id, label_ids, limit, offset |
job.detail | Detail einer Stellenanzeige inklusive Beschreibung, Galerie und Video | job_id |
job.response | Antwort auf eine Stellenanzeige – legt den Bewerber und seine Bewerbung an | job_id, first_name, last_name, email, mobile, response_text, cv_file_name, cv_base64 |
person.register | Bewerberregistrierung ohne Bezug zu einer Stellenanzeige | first_name, last_name, email, mobile, cost_center, emergency_contact, note, cv_file_name, cv_base64 |
department.list | Dem aufrufenden Konto zugewiesene Arbeitsorte | keine Parameter |
cost_center.list | Kostenstellen („Ich möchte arbeiten als“) | department_id |
sms.gateway.* | Eigenes SMS-Gateway – Konfiguration, Ausgabe der Nachrichten, Zustellberichte, eingehende Nachrichten und Anrufe | je nach Funktion |
Die API sendet von sich aus keine E-Mails. Eine Bestätigungs- oder Willkommensnachricht entsteht nur, wenn der Aufruf die ID einer E-Mail-Vorlage übergibt – die Vorlage verwalten Sie in Ihrem Konto.
Verwandte Module