+49 40 6094641 30
API-Dokumentation
Unsere API-Dokumentation hilft Ihnen beim Einstieg in die Entwicklung mit unserer API und beschreibt alle Funktionen der Toptranslation-API im Detail.
individuelle Programmierung
Schnittstelle (API)
Für unsere Kunden sollen alle Prozesse, die Übersetzungen betreffen, so einfach wie möglich sein. Wir entwickeln deshalb kontinuierlich neue technische Lösungen.
Sie möchten Ihre Unternehmenswebsite internationalisieren oder Ihren E-Shop in mehreren Ländern betreiben? Über unsere REST-API (Programmierschnittstelle) können Sie direkt und unkompliziert Textinhalte von Ihrem Content-Management-System – oder jeder anderen Anwendung – in unser System übertragen. Mit einem Klick geben Sie eine neue Übersetzung in Auftrag und ebenso einfach kommen die Übersetzungen dank Webhooks in Ihr System zurück. Und zwar im passenden Format für Ihr Programm. So verwalten Sie auch große Übersetzungsaufträge ganz einfach, denn Applikationen wie Content-Management-Systeme, ERP oder E-Shops können problemlos an unsere API angebunden werden. Das große Plus für Sie: Sie behalten stets den Überblick über den aktuellen Auftragsstatus und können jeden einzelnen Arbeitsschritt mitverfolgen.
Individuelle Lösungen für Ihre Bedürfnisse
Auf Wunsch entwickelt unser Technikteam mit Ihnen gemeinsam ein spezifisches Plug-in, um Ihr System an die API anbinden zu können. Der mühselige Datentransfer per E-Mail sowie der manuelle Import und Export einzelner Dokumente entfällt. Fehlerquellen werden deutlich reduziert und Sie sparen Zeit. Über die API können Sie Ihr Nutzerkonto von einer anderen Website oder von einem mobilen Endgerät aus nutzen. Managen Sie Ihre Übersetzungsaufträge also ganz bequem von Ihrer Benutzeroberfläche aus.
REST-API
Die Toptranslation-API verfolgt das REST-Paradigma und liefert Antworten in JSON-Notation. Die Anfragen werden in Form von HTTP-Requests gestellt, die über SSL gesichert werden.
Authentifzierung
Als Authentifizierung wird ein Token bei jedem Request übermittelt, ein OAuth-Workflow für die Authentifizierung ist in Planung.
Webhooks
Die Toptranslation-API kann die Systeme der Kunden über Webhooks über fertiggestellte Lieferungen, Änderungen des Auftragsstatus oder andere Aktivitäten informieren. Die Ziel-URL von Webhooks können frei definiert werden. Der Request eines Webhooks übermittelt Informationen zu dem Projektstatus oder der fertiggestellten Übersetzung in JSON-Notation.
Dateiserver
Dokumente und Daten werden in den Toptranslation-Systemen aus Sicherheitsgründen getrennt gehalten. Der Austausch von Dokumenten findet über den Toptranslation-Dateiserver DocumentStore statt. Eine genaue Beschreibung der DocumentStore-API wird von Toptranslation im Entwickler-Portal bereitgestellt: developer.toptranslation.com
Plug-ins und Integrationen
Für verschiedene Content-Management-Systeme können Plug-ins oder Integrationen von Toptranslation angeboten werden die verwendet werden können um Content aus dem CMS des Kunden an die Toptranslation-API zu übertragen. Auf Wunsch können individuelle Lösungen durch Toptranslation entwickelt werden.
Über API zu verwaltende Ressourcen
Über die Toptranslation-API können folgende Ressourcen des Übersetzungsmanagements verwaltet werden:
- Übersetzungsaufträge
- Übersetzte Dokumente
- Referenzdokumente (Translation Memories, Glossare, Styleguides etc.)
- Kostenstellen
- Teams
- Angebote
- Rechnungen
Übersetzungsworkflow mit der Toptranslation-API
- Übersetzungsauftrag erstellen: über die API können Informationen wie das gewünschte Lieferdatum, die Kostenstelle, ein Briefing, ein interner Projektname oder Referenz oder ein Service-Level angegeben werden.
- Übertragung der zu übersetzenden Dokumente: Dokumente werden über HTTP-Requests auf den Dateiserver hochgeladen und mittels API-Endpunkt zu der dem Übersetzungsauftrag hinzugefügt. Hierbei werden die gewünschten Sprachenkombinationen übergeben.
- Angebotserstellung durch Toptranslation (optional): wenn gewünscht erstellt Toptranslation ein Angebot und stellt dieses über die API zur Verfügung. Das System des Kunden kann per Webhook oder eine E-Mail über die Erstellung eines Angebots informiert werden.
- Annehmen des Angebots (optional): das von Toptranslation bereitgestellte Angebot kann über die API angenommen oder abgelehnt werden.
- Beginn des Übersetzungsprozesses: die Toptranslation-API informiert das System des Kunden über Webhooks über Statusänderungen.
- Abrufen des aktuellen Übersetzungsstandes (optional): das System des Kunden kann den aktuellen Status des Projektes und den prozentualen Fortschritt jederzeit über die Toptranslation-API abfragen.
- Bereitstellung von übersetzten Dokumenten: die Toptranslation-API informiert das System des Kunden über Webhooks über die Bereitstellung eines übersetzten Dokumentes. Dieses kann dann über den Dateiserver mittels HTTP-Request heruntergeladen werden.
- Rechnungsstellung: über die Toptranslation-API können die Rechnungen zu einem Übersetzungsauftrag abgerufen werden und deren Belege als PDF von dem Dateiserver heruntergeladen werden.
