API documentation CertificateGenerator

Information about the integration of the zeugnisgenerator for easy creation of job references.

Booth: 11/19

Introduction

The verlingo CertificateGenerator API is designed according to the principles of REST built. Our API has a single endpoint and we return API errors via standard http response codes.

All access is via HTTPS to our main endpoint.

https://zg.verlingo.de/zeugniserstellung

Important: We do not accept unsecured HTTP requests for security reasons. Only HTTPS requests are accepted.

Authentication

Each user of our API receives individual access data. If you are interested in integrating our service, please send us a short email to info@verlingo.de

Identifier and API password

You simply specify these credentials as identifier and API password via HTTP Authorization header. The identifier and API password must be base64 encoded.

HTTP-VERB: ("Authorization", "Basic " + IHR_API key)

API key

You simply specify these credentials as API key via HTTP Authorization header. The API key must be base64 encoded.

HTTP-VERB: ("Authorization", IHR_API key)

Request

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

Please note: The format used must be specified with each request by means of the Content-Type header. In the case of JSON, the header must be set to application/json.

Basic request

http-Header:

{ 
  "Content-Type": "application/json"
  "Accept": "application/json"
  "Authorization": IHR_API key
}

http-Body:

{
"Anrede": "w" oder "m" oder "n",
"Vorname": "First name",
"Nachname": "Last name",
"Geburtsort": "Birthplace",
"Geburtsdatum": "17.06.1984",
"Firmenbezeichnung": "Company name",
"Firmenbeschreibung": "Company description",
"Zeugnisart": "0"(Job reference) or "1"(Interim report) or "2"(Training certificate) or "3"(Internship certificate),
"Zeitform": "0"(Neutral) or "1"(Presence) or "2"(Past),
"Berufsbezeichnung": "Job title",
"Abteilung": "Department",
"Beschaeftigungsbeginn": "17.06.2015",
"Beschaeftigungsende": "17.06.2018",
"Taetigkeiten": [
"Activity 1",
"Activity 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": "Audit Chamber",
"Erfolge": "5"(Note 1 - 5),
"Projekt": "Project name and description",
"Fuehrung": "2"(Note 1 - 5),
"VerhaltenIntern": "3"(Note 1 - 5),
"VerhaltenExtern": "5"(Note 1 - 5),
"Beendigungsgrund": "see 'attribute termination reason",
"Ausstellungsgrund": "see 'Attribute exhibition reason",
"Zukunftswuensche": "1"(Note 1 - 5),
"Wiedereinstellung": "1"(If not wanted, omit or set to "0)
}

Attribute termination reason

20 -> Termination reason (dismissed)
21 -> Reason for termination (own request)
22 -> Termination reason (operational)
23 -> Termination reason (deadline)
24 -> Reason for termination (mutually agreed)
33 -> Termination reason (study)
34 -> Termination reason (insolvency)

Attribute reason for exhibition

35 -> Certificate occasion (change of supervisor)
36 -> Certificate occasion (job change internal)
37 -> Certificate occasion (change of department)
38 -> Certificate occasion (change in the group)
39 -> Certificate occasion (parental leave)
40 -> Certificate occasion (insolvency)
41 -> Testimony occasion (own request)
42 -> Certificate occasion (change of shareholder)
43 -> Certificate occasion (application)
44 -> Certificate occasion (promotion)
45 -> Certificate occasion (study)

HTTP status codes

Below is a list of the most important HTTP status codes that the verlingo API outputs and how you can interpret them. In general, 200s codes stand for a successful request, 400s for an error in the request data (for example, a mandatory parameter is missing) and 500s for an error on our servers.

Code	Meaning
200 OK	Successful request
400 Bad Request	Syntax error in request body
401 Unauthorized	Incorrect or missing authentication
404 Not Found	The resource could not be found
406 Not Acceptable	The format of the request is not supported
417 Expectation Failed	The information transmitted is not as expected
500, 502, 503 Server Error	Server error. Repeat the request after a short time and contact us if the error occurs permanently

Response

You will always receive a response from our API in JSON format and HTTP status code 200 on a successful response.

Response structure

"message": "Success",
"Zeugnis": {
"Anrede": "m",
"Vorname": "First name",
"Nachname": "Last name",
"Ueberschrift": "Job reference",
"Einleitung": {
"Text": "Mr. Last Name born in Place of Birth, joined our company on 06/17/2015 and worked in the department as a job title until 06/17/2018.",
"Note": 0,
"Kategorie": 53,
"KategorieBezeichnung": "Introduction (with department)",
"Zeitform": 2,
"Zeugnisart": 0
},
"Pkammer": "Audit Chamber",
"Pruefungsergebnis": null,
"Unternehmen": "Company name",
"Firmenbeschreibung": "Company description",
"EinleitungTaetigkeiten": {
"Text": "The focus of Mr. nachname's activities was as follows:",
"Note": 0,
"Kategorie": 3,
"KategorieBezeichnung": "Introduction activities",
"Zeitform": 2,
"Zeugnisart": 0
},
"Taetigkeiten": [
"Activity 1",
"Activity 2"
],
"Leistung": {
"Fachwissen": {
"Text": "Mr. Surname has an extremely profound expertise, which he always used effectively and successfully in practice.",
"Note": 1,
"Kategorie": 12,
"KategorieBezeichnung": "Expertise",
"Zeitform": 2,
"Zeugnisart": 0
},
"Weiterbildung": {
...
},
"Auffassungsgabe": {
...
},
"Belastbarkeit": {
...
},
"Arbeitsweise": {
...
},
"Arbeitserfolg": {
...
},
...
}
}