API documentation CertificateGenerator

Information on the integration of the ZeugnisGenerator for the simple creation of references.

Release Date: 11/19

Introduction

The verlingo CertificateGenerator API is designed according to the principles of REST constructed. 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 an integration of 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 the API password must be base64 encoded.

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

API Key

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

HTTP-VERB: ("Authorization", YOUR_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": YOUR_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"(Grade 1 - 5),
"Weiterbildung": "2"(Grade 1 - 5),
"Belastbarkeit": "3"(Grade 1 - 5),
"Auffassungsgabe": "4"(Grade 1 - 5),
"Arbeitsweise": "5"(Grade 1 - 5),
"Arbeitserfolg": "1"(Grade 1 - 5),
"Motivation": "2"(Grade 1 - 5),
"Gesamtleistung": "3"(Grade 1 - 5),
"Pruefungsergebnis": "4"(Grade 1 - 5),
"Pkammer": "Audit Chamber",
"Erfolge": "5"(Grade 1 - 5),
"Projekt": "Project name and description",
"Fuehrung": "2"(Grade 1 - 5),
"VerhaltenIntern": "3"(Grade 1 - 5),
"VerhaltenExtern": "5"(Grade 1 - 5),
"Beendigungsgrund": "see 'attribute termination reason",
"Ausstellungsgrund": "see 'Attribute exhibition reason",
"Zukunftswuensche": "1"(Grade 1 - 5),
"Wiedereinstellung": "1"(If not desired, 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 (by mutual agreement)
  • 33 -> Termination reason (study)
  • 34 -> Termination reason (insolvency)

Attribute reason for issue

  • 35 -> Certificate occasion (change of superior)
  • 36 -> Certificate occasion (internal job change)
  • 37 -> Certificate occasion (department change)
  • 38 -> Certificate reason (change in the group)
  • 39 -> Certificate occasion (parental leave)
  • 40 -> Certificate reason (insolvency)
  • 41 -> Certificate 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, 200 codes represent a successful request, 400 codes represent an error in the request data (for example, a mandatory parameter is missing), and 500 codes represent an error on our servers.

Code Meaning
200 OK Successful request
400 Bad Request Syntax error in the 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 provided is not as expected
500, 502, 503 Server Error Server error. Repeat the request after a short time and report to 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.

Structure of the response

"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 17/06/2015 and worked as a professional title in the department till 17/06/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 technical knowledge, which he always used effectively and successfully in practice.",
"Note": 1,
"Kategorie": 12,
"KategorieBezeichnung": "Expertise",
"Zeitform": 2,
"Zeugnisart": 0
},
"Weiterbildung": {
...
},
"Auffassungsgabe": {
...
},
"Belastbarkeit": {
...
},
"Arbeitsweise": {
...
},
"Arbeitserfolg": {
...
},
...
}
}
Icon For Arrow-up