API Dokumentation

Einleitung

Basis URL: https://api.lengoo.com/v1

Sandbox URL: https://api.sandbox.lengoo.com/v1

Endpunkte

Endpunkt 1: Erstelle Projekt - Kunden erstellen Übersetzungs- bzw. Korrekturleserprojekt. Mindestens ein Dokument oder Text muss mitgeschickt werden.

Endpunkt 2: Erhalte Projektinformationen - Kunden können Projektinformation abfragen bzw. die finalen Dokumente herunterladen

Authentifizierung

Die Endpunkte sind nur per API Token abrufbar. Der API Token is notwendig, um die Zugangsberechtigung des Kunden zu ermitteln und die korrekte Authentifizierung sicherzustellen. Der API Token wird von Lengoo zur Verfügung gestellt. Die Authentifizierung beinhaltet den Token und die Kunden_ID.

Beispiel: uKXW0nV93234lbQxo0k2-9999 (TOKEN-Kunden_ID)

Endpunkt 1: Erstelle Projekt

POST https://api.lengoo.com/v1/projects

Schlüssel	Restriktion	Wert	Beschreibung
Authorization	Pflicht	TOKEN-CUSTOMER_ID	Authentifizierung des Kunden durch Token und Kunden_ID

Schlüssel	Restriktion	Wert	Beschreibung
type	Pflicht	string - [TR, PR] Standardwert: TR	Art des Projekts, TR für Übersetzung und PR für Korrekturlesen
quality	Optional	string - [PR, BU] Standardwert: PR	Qualitätslevel, PR für Premium und BU für Business
industry	Optional	string - siehe Anhang	Fachbereichsabkürzung (Art des Inhalts) für die Dokumente/Texte
language_from	Pflicht	string - siehe Anhang	Abkürzung der Ausgangssprache der Dokumente/Texte
languages_to	Pflicht	array - see Anhang	Array an Zielsprache(n) der Dokumente/Texte
documents	Pflicht	list - id, content und filename	Liste an Dokumenten zu übersetzen, Inhalt in Base64, Dateiname und id sollten einzigartig sein
id	Pflicht	string	Einzigartige id für jedes Dokument
content	Pflicht	string	Inhalt des Dokuments, das übersetzt werden soll, in base64
filename	Optional	string	Einzigartiger Dateienname, um die Datei später zuzuordnen
texts	Pflicht	list - id, content und filename	Liste an Texten, die übersetzt werden sollen, der Inhalt sollte blanko Text sein
delivery	Optional	string - [$date YYYY-MM-DD HH:mm]	Lieferdatum erwünscht, Standard Lieferdatum wird automatisch gesetzt und als Standard behandelt

Weiterführende Informationen

Der API Token und die Kunden_ID für die Authentifizierung werden von Lengoo zur Verfügung gestellt
Die Sprach- und Fachbereichsabkürzungen finden sie im Anhang.
Die Felder Dokumente (Documents) und Texte (texts) sind optional aber es muss mindestens eins von beiden mitgeschickt werden.
Der Dateienname und die eigene ID sollten einzigartig sein.

Antwort

Schlüssel	Restriktion	Wert	Beschreibung
Antwort Codes	Pflicht	string - siehe Anhang	Success, error oder validation code

Schlüssel	Restriktion	Wert	Beschreibung
id	Pflicht	string	Projekt ID
type	Pflicht	string - [TR, PR]	Art des Projekts, TR für Übersetzung und PR für Korrekturlesen
quality	Pflicht	string - [PR, BU]	Qualitätslevel, PR für Premium und BU für Business
industry	Optional	string	Fachbereichsabkürzung (Art des Inhalts) für die Dokumente/Texte
language_from	Pflicht	string	Abkürzung der Ausgangssprache der Dokumente/Texte
languages_to	Pflicht	array	Array an Zielsprache(n) der Dokumente/Texte
delivery	Pflicht	array - delivery_date, level, percentage	Lieferinformationen
delivery_date	Pflicht	string - [$date YYYY-MM-DD HH:mm]	Lieferdatum
level	Pflicht	string - [standard, express]	Standard für das Standarddatum, Express für selbst ausgewähltes Datum
percentage	Pflicht	integer - [0 - 100]	Expressaufschlag wird Preis hinzugefügt in Abhängigkeit vom selbst gewählten Lieferdatum
order	Pflicht	array - id, price, wordcount, deadline	Bestellinformation
id	Pflicht	string	Bestellnummer von Lengoo
price	Pflicht	number	Preis in €
wordcount	Pflicht	integer	Gesamte Wortanzahl des Projekts
deadline	Pflicht	string - [$date YYYY-MM-DD HH:mm]	Lieferdatum der Projekts

{
  "data": {
    "id": "59afcef4e27d6b8392173f00",
    "type": "TR",
    "quality": "PR",
    "industry": "gen",
    "language_from": "en",
    "languages_to": [
      "fr",
      "de"
    ],
    "delivery": {
      "delivery_date": "2019-10-29 12:00",
      "level": "express",
      "percentage": 20
    },
    "order": {
      "id": 11,
      "price": 123.23,
      "wordcount": 1230,
      "deadline": "2019-10-28 16:00"
    },
    "status": "created"
  },
  "error": {},
  "validations": []
}

{
  "data": [],
  "validations": [
    {
      "code": "some-validation-code",
      "message": "Some message for humans",
      "attribute": "attribute_name",
      "value": "given_value"
    }
  ],
  "error": {
    "code": "some-error-code",
    "message": "Some message for humans"
  }
}

Weiterführende Informationen

Neben der allgemeinen Validierung der Anfrage, sind folgende Validierung für diese Anfrage möglich.
projects/invalid-express-date - wenn der Nutzer ein Express Lieferdatum wählt, was syntaktisch nicht korrekt ist.
projects/missing-express-date - wenn der Nutzer ein Express Lieferdatum wählt, was kein valides Datum ist.
projects/incorrect-express-date - wenn der Nutzer ein Express Lieferdatum wählt, was nicht den vereinbarten Lieferzeiten entspricht.
projects/invalid-language-code - wenn der Nutzer eine invalide Sprachabkürzung (ISO code) für Ausgangs- oder Zielsprache wählt.
projects/empty-request - wenn die Anfrage keine oder zu wenig Daten enthält (z.b. wurde weder ein Dokument noch ein Text mitgeschickt).
projects/unsupported-language-combination - wenn eine der Sprachkombinationen vom System nicht unterstützt wird (in der Antwort wird diese Sprachkombination spezifiziert).
projects/big-request - die gesamte Anfrage ist zu groß

Endpunkt 2: Erhalte Projektinformationen

GET https://api.lengoo.com/v1/projects/[projectId]

Schlüssel	Restriktion	Wert	Beschreibung
Authorization	Pflicht	TOKEN-Kunden_ID	Authentifizierung des Kunden durch Token und Kunden_ID

Schlüssel	Restriktion	Wert	Beschreibung
projectId	Pflicht	string	Projekt ID

Antwort

Schlüssel	Restriktion	Wert	Beschreibung
Antwort Codes	Pflicht	integer - siehe Anhang	Success, error oder validation code

Schlüssel	Restriktion	Wert	Beschreibung
id	Pflicht	string	Projekt ID
type	Pflicht	string - [TR, PR]	Art des Projekts, TR für Übersetzung und PR für Korrekturlesen
language_from	Pflicht	string	Abkürzung der Ausgangssprache der Dokumente/Texte
languages_to	Pflicht	array	Array an Zielsprache(n) der Dokumente/Texte
wordcount	Pflicht	integer	Gesamte Wortanzahl des Projekts
delivery	Pflicht	array - delivery_date, level, percentage	Delivery information
delivery_date	Pflicht	string - [$date YYYY-MM-DD HH:mm]	Lieferdatum
level	Pflicht	string - [standard, express]	Standard für das Standarddatum, Express für selbst ausgewähltes Datum
percentage	Pflicht	string - [0 - 100]	Expressaufschlag wird Preis hinzugefügt in Abhängigkeit vom selbst gewählten Lieferdatum
status	Pflicht	string	Status es Projekts
documents	Pflicht	list - id, language, content, filename, originalFilename	Liste der übersetzten Dokumente
id	Pflicht	string oder null	Eine id wird für Texte eingefügt, null für Dokumente
language	Optional	string	Sprache des übersetzten Dokuments
content	Pflicht	string	Inhalt (Base64) des übersetzten Dokuments
filename	Pflicht	string	Dateiname des übersetzten Dokuments
originalFilename	Pflicht	string	Dateiname des Originaldokuments

{
  "data": {
    "id": "5c80fedfd6e02b0018574d51",
    "type": "TR",
    "language_from": "en",
    "languages_to": [
      "fr",
      "de"
    ],
    "wordcount": 1230,
    "delivery": {
      "delivery_date": "2019-10-2019 12:00",
      "level": "express",
      "percentage": 20
    },
    "status": "done",
    "documents": [
      {
        "id": "1001",
        "language": "fr",
        "content": "QW4gd2VsY2hlIMOEdcOfZXJ1bmdlbiB2b24gQW5nZWxhIE1lcmtlbCB3aXJkIG1hbiBzaWNoIGVyaW5uZXJuLC...",
        "filename": "API_Doc_Example_fr.docx",
        "originalFilename": "API_Doc_Example.docx"
      },
      {
        "id": "1001",
        "language": "de",
        "content": "QW4gd2VsY2hlIMOEdcOfZXJ1bmdlbiB2b24gQW5nZWxhIE1lcmtlbCB3aXJkIG1hbiBzaWNoIGVyaW5uZXJuLC...",
        "filename": "API_Doc_Example_de.docx",
        "originalFilename": "API_Doc_Example.docx"
      }
    ]
  },
  "error": {},
  "validations": []
}

{
  "data": [],
  "validations": [
    {
      "code": "some-validation-code",
      "message": "Some message for humans",
      "attribute": "attribute_name",
      "value": "given_value"
    }
  ],
  "error": {
    "code": "some-error-code",
    "message": "Some message for humans"
  }
}

Weiterführende Informationen

Der Status zeigt den Fortschritt des Projekts an.
Mögliche Fortschritte: in_creation, in_progress und done.
Wenn das Projekt beendet wurde, enthält die Antwort die finalen übersetzten Dokumente (Schlüssel: content)

Anhang

Antwort Codes

Code	Beschreibung
200	Success – Ihre Anfrage war erfolgreich
400	Bad Request – Ihre Anfrage war invalide
401	Unauthorized – Ihre Authentifizierung war falsch
403	Forbidden – Verbotene Anfrage
404	Not Found – Anfrage konnte nicht gefunden werden
405	Method Not Allowed – Sie haben versucht den Endpunkt mit einer invaliden Methode abzurufen

Abkürzungen Fachbereiche

Abkürzung	Fachbereich
arch	Architektur, Bauingenieurwesen & Immobilien
car	Automobil
bio	Biotechnologie
elec	Elektronik & Elektrotechnik
air	Luft- & Raumfahrt
env	Umwelttechnik
ener	Energie, Stromerzeugung
mech	Maschinen- & Anlagenbau
medtech	Medizintechnik
it	IT & Software
med	Medizin & Pharmazie
psy	Psychologie
ero	Erotik
media	Medien, Kommunikation & Öffentlichkeitsarbeit
tele	Telekommunikation
cons	Consulting
int	Internet & E-Commerce
hr	Personalwesen
mark	Marketing & Werbung
tour	Tourismus & Reisen
chem	Chemie
math	Mathematik & Physik
hum	Geistes- & Sozialwissenschaften
hist	Geschichte
pol	Politik & Verwaltung
fin	Finanzen & Versicherung
trans	Transport & Logistik
eco	Wirtschaft, Handel & Unternehmertum
cert	Zeugnisse
leg	Rechtliches, Verträge & Juristische Texte
cv	Lebensläufe, Motivationsschreiben
bea	Kosmetik & Beautyartikel
mod	Mode- & Textilindustrie
food	Lebensmittel & Ernährung
spo	Sport, Fitness & Gesundheit
art	Kunst
mus	Musik
gen	Allgemeines
fam	Familie & Kind
gam	Spiele & Videospiele

Abkürzungen Sprachen

Abkürzung	Sprache
en	Englisch
de	Deutsch
es	Spanisch
fr	Französisch
el	Griechisch
it	Italienisch
nl	Niederländisch
pt	Portugiesisch
ru	Russisch
tr	Türkisch
zh	Chinesisch
ko	Koreanisch
ar	Arabisch
he	Hebräisch
da	Dänisch
no	Norwegisch
hu	Ungarisch
sv	Schwedisch
ja	Japanisch
en-GB	Englisch (Britisch)
en-US	Englisch (Amerikanisch)
es-419	Spanisch (Lateinamerikanisch)
es-ES	Spanisch (Europäisch)
es-MX	Spanisch (Mexikanisch)
cs	Tschechisch
hr	Kroatisch
pt-BR	Portugiesisch (Brasilianisch)
pt-PT	Portugiesisch (Europäisch)
zh-Hans	Chinesisch (vereinfacht)
zh-Hant	Chinesisch (traditionell)
fr-CH	Französisch (Schweizerisch)
de-CH	Deutsch (Schweizerisch)
en-AU	Englisch (Australisch)
nl-BE	Flämisch
lb	Luxemburgisch
sk	Slowakisch