API-Dokumentation Zeugnisgenerator

Informationen zur Integration des Zeugnisgenerators zur einfachen Erstellung von Arbeitszeugnissen.

Stand: 11/19

Einführung

Die verlingo Zeugnisgenerator API ist nach den Prinzipien von REST aufgebaut. Unsere API besitzt einen einzigen Endpunkt und wir geben über Standard-http-Response-Codes API-Fehler zurück.

Alle Zugriffe erfolgen per HTTPS auf unseren Hauptendpunkt.

https://zg.verlingo.de/zeugniserstellung

Wichtig: Ungesicherte HTTP-Anfragen nehmen wir aus Sicherheitsgründen nicht entgegen. Es werden nur HTTPS-Anfragen angenommen.

Authentifizierung

Jeder Nutzer unserer API erhält individuelle Zugangsdaten. Sollten Sie interesse an einer Integration unseres Services haben, dann schicken Sie uns eine kurze Email an info@verlingo.de

Identifier und API Passwort

Diese Zugangsdaten geben Sie einfach per HTTP-Authorization Header als Identifier und API-Passwort an. Der Identifier und das API-Passwort müssen base64 codiert sein.

HTTP-VERB: ("Authorization", "Basic " + IHR_API-Schlüssel)

API-Schlüssel

Diese Zugangsdaten geben Sie einfach per HTTP-Authorization Header als API-Schlüssel an. Der API-Schlüssel muss base64 codiert sein.

HTTP-VERB: ("Authorization", IHR_API-Schlüssel)

Anfrage

POST https://zg.verlingo.de/zeugniserstellung

Bitte beachten: Das verwendete Format muss bei jedem Request mittels des Headers Content-Type mit angegeben werden. Im Falle von JSON muss der Header auf application/json gesetzt werden.

Basis-Anfrage

http-Header:

{ 
  "Content-Type": "application/json"
  "Accept": "application/json"
  "Authorization": IHR_API-Schlüssel
}

http-Body:

{
"Anrede": "w" oder "m" oder "n",
"Vorname": "Vorname",
"Nachname": "Nachname",
"Geburtsort": "Geburtsort",
"Geburtsdatum": "17.06.1984",
"Firmenbezeichnung": "Firmenbezeichnung",
"Firmenbeschreibung": "Firmenbeschreibung",
"Zeugnisart": "0"(Arbeitszeugnis) oder "1"(Zwischenzeugnis) oder "2"(Ausbildungszeugnis) oder "3"(Praktikumszeugnis),
"Zeitform": "0"(Neutral) oder "1"(Präsenz) oder "2"(Vergangenheit),
"Berufsbezeichnung": "Berufsbezeichnung",
"Abteilung": "Abteilung",
"Beschaeftigungsbeginn": "17.06.2015",
"Beschaeftigungsende": "17.06.2018",
"Taetigkeiten": [
"Taetigkeit 1",
"Taetigkeit 2",
…
],
"Fachwissen": "1"(Note 1 - 5),
"Weiterbildung": "2"(Note 1 - 5),
"Belastbarkeit": "3"(Note 1 - 5),
"Auffassungsgabe": "4"(Note 1 - 5),
"Arbeitsweise": "5"(Note 1 - 5),
"Arbeitserfolg": "1"(Note 1 - 5),
"Motivation": "2"(Note 1 - 5),
"Gesamtleistung": "3"(Note 1 - 5),
"Pruefungsergebnis": "4"(Note 1 - 5),
"Pkammer": "Prüfungskammer",
"Erfolge": "5"(Note 1 - 5),
"Projekt": "Projektname und Beschreibung",
"Fuehrung": "2"(Note 1 - 5),
"VerhaltenIntern": "3"(Note 1 - 5),
"VerhaltenExtern": "5"(Note 1 - 5),
"Beendigungsgrund": "siehe ‘Attribut Beendigungsgrund‘",
"Ausstellungsgrund": "siehe ‘Attribut Ausstellungsgrund‘",
"Zukunftswuensche": "1"(Note 1 - 5),
"Wiedereinstellung": "1"(Wenn nicht gewollt weglassen oder auf "0" setzen)
}

Attribut Beendigungsgrund

20 -> Beendigungsgrund (entlassen)
21 -> Beendigungsgrund (eigener Wunsch)
22 -> Beendigungsgrund (betrieblich)
23 -> Beendigungsgrund (frist)
24 -> Beendigungsgrund (einvernehmlich)
33 -> Beendigungsgrund (Studium)
34 -> Beendigungsgrund (Insolvenz)

Attribut Ausstellungsgrund

35 -> Zeugnisanlass (Vorgesetztenwechsel)
36 -> Zeugnisanlass (Jobwechsel intern)
37 -> Zeugnisanlass (Abteilungswechsel)
38 -> Zeugnisanlass (Wechsel im Konzern)
39 -> Zeugnisanlass (Elternzeit)
40 -> Zeugnisanlass (Insolvenz)
41 -> Zeugnisanlass (eigene Wunsch)
42 -> Zeugnisanlass (Gesellschafterwechsel)
43 -> Zeugnisanlass (Bewerbung)
44 -> Zeugnisanlass (Beförderung)
45 -> Zeugnisanlass (Studium)

HTTP Status-Codes

Im Folgenden finden Sie eine Liste der wichtigsten HTTP-Status-Codes, die die verlingo API ausgibt, und wie Sie diese interpretieren können. Im Allgemeinen stehen 200er-Codes für einen erfolgreichen Request, 400er für einen Fehler in den Request-Daten (zum Beispiel fehlt ein zwingend anzugebender Parameter) und 500er für einen Fehler auf unseren Servern.

Code	Bedeutung
200 OK	Erfolgreiche Anfrage
400 Bad Request	Syntax-Fehler im Request-Body
401 Unauthorized	Falsche oder fehlende Authentifizierung
404 Not Found	Die Ressource konnte nicht gefunden werden
406 Not Acceptable	Das Format der Anfrage wird nicht unterstützt
417 Expectation Failed	Die übermittelten Informationen sind nicht wie erwartet
500, 502, 503 Server Error	Serverfehler. Wiederholen Sie die Anfrage nach kurzer Zeit und melden Sie sich bei uns, falls der Fehler dauerhaft auftritt

Response

Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.

Struktur der Antwort

"message": "Success",
"Zeugnis": {
"Anrede": "m",
"Vorname": "Vorname",
"Nachname": "Nachname",
"Ueberschrift": "Arbeitszeugnis",
"Einleitung": {
"Text": "Herr Nachname geb. in Geburtsort, trat am 17.06.2015 in unser Unternehmen ein und war bis zum 17.06.2018 als Berufsbezeichnung im Abteilung tätig.",
"Note": 0,
"Kategorie": 53,
"KategorieBezeichnung": "Einleitung (mit Abteilung)",
"Zeitform": 2,
"Zeugnisart": 0
},
"Pkammer": "Prüfungskammer",
"Pruefungsergebnis": null,
"Unternehmen": "Firmenbezeichnung",
"Firmenbeschreibung": "Firmenbeschreibung",
"EinleitungTaetigkeiten": {
"Text": "Die Schwerpunkte von Herrn nachnames Tätigkeiten gestalteten sich wie folgt:",
"Note": 0,
"Kategorie": 3,
"KategorieBezeichnung": "Einleitung Tätigkeiten",
"Zeitform": 2,
"Zeugnisart": 0
},
"Taetigkeiten": [
"Taetigkeit 1",
"Taetigkeit 2"
],
"Leistung": {
"Fachwissen": {
"Text": "Herr Nachname verfügt über ein äußerst profundes Fachwissen, welches er stets effektiv und erfolgreich in der Praxis einsetzte.",
"Note": 1,
"Kategorie": 12,
"KategorieBezeichnung": "Fachwissen",
"Zeitform": 2,
"Zeugnisart": 0
},
"Weiterbildung": {
...
},
"Auffassungsgabe": {
...
},
"Belastbarkeit": {
...
},
"Arbeitsweise": {
...
},
"Arbeitserfolg": {
...
},
...
}
}