Universally verfügt über zwei APIs, und welche Sie benötigen, hängt davon ab, was Sie erstellen. Eine übersetzt Inhalte, die andere verwaltet Ihr Konto. Beide sind mit Live-Anfragebeispielen unter developer.universally.com dokumentiert.
Die beiden APIs
| Übersetzer-API | Plattform-API | |
|---|---|---|
| Host | translator.universally.com |
api.universally.com |
| Referenz | Öffnen Sie die Spezifikation | Öffnen Sie die Spezifikation |
| Für | Inhalte in eine andere Sprache übersetzen | Verwaltung von Projekten, Sprachen, Glossaren und gespeicherten Übersetzungen |
| Schlüssel | der private API-Schlüssel des Projekts | ein Workspace-API-Schlüssel |
| Verwendet von | dem WordPress-Plugin und Ihrer eigenen Integration | Skripten und Tools rund um das Dashboard |
Wenn Sie das WordPress-Plugin auf einer anderen Plattform ersetzen, ist die Übersetzer-API die richtige für Sie. Die Plattform-API dient zur Automatisierung des Dashboards, nicht zur Bereitstellung von Seiten.
Erstellen Sie zuerst ein Projekt
Ein Projekt ist das, was Ihre Domain, Ihre Quellsprache, Ihre Zielsprachen und Ihre Schlüssel enthält. Es kommt also vor jedem API-Aufruf. Zwei Möglichkeiten, eines zu erstellen.
Im Dashboard. Öffnen Sie Neues Projekt. Wählen Sie Ihre Technologie bietet derzeit nur WordPress: die anderen Optionen tragen einen Coming Soon-Badge und können nicht ausgewählt werden. Das ist in Ordnung für eine API-Integration, da die Technologie nur ändert, was das Dashboard Ihnen anzeigt, nicht was die Übersetzer-API akzeptiert. Eine zu erwartende Konsequenz: Der Bildschirm API-Einstellungen des Projekts meldet weiterhin "Universally-Plugin nicht erkannt", da es für ein WordPress-Projekt nach dem Plugin auf Ihrer Domain sucht. Nichts ist falsch und die Übersetzung funktioniert unabhängig davon.
Mit der Plattform-API. POST /sites erstellt ein Projekt mit einem Workspace pak_-Schlüssel und nimmt name, domain, sourceLanguage und tech entgegen. Verwenden Sie tech: "wordpress" für eine Website mit einer Domain oder tech: "app", wenn keine Domain angegeben werden kann. tech: "website" und der Subdomain-Modus befinden sich in einer geschlossenen Beta und werden derzeit abgelehnt. Senden Sie keine workspaceId: sie wird aus dem Schlüssel übernommen.
curl -X POST https://api.universally.com/sites \
-H "X-API-Key: $UNIVERSALLY_PLATFORM_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Docs site","domain":"example.com","sourceLanguage":"en-us","tech":"wordpress"}'
Fügen Sie dann Zielsprachen hinzu, entweder auf dem Bildschirm Alle Sprachen des Projekts oder über die Plattform-API, und kopieren Sie den Projektschlüssel aus den API-Einstellungen.
Die Übersetzer-API
Drei Endpunkte, alle POST, alle authentifiziert mit dem privaten Schlüssel des Projekts in einem X-API-Key-Header:
| Endpunkt | Senden Sie es |
|---|---|
/v1/translate/html |
eine gerenderte Seite, wenn Sie komplettes HTML übergeben können |
/v1/translate/strings |
ein Array von Zeichenfolgen, wenn Sie den Inhalt selbst verwalten |
/v1/translate |
entweder, und es entscheidet, welche der obigen Optionen zutrifft |
Der HTML-Endpunkt entspricht am ehesten der Funktionsweise des Plugins: Ihr Server sendet die Seite, die er zurückgeben wollte, und gibt zurück, was er erhält. Nichts muss im Voraus wissen, welcher Text auf der Seite steht. Siehe Übersicht über die REST-API für die Anforderungs- und Antwortstrukturen und API-Fehler und -Limits, um zu erfahren, was Sie erwarten können, wenn mitten in einer Anfrage ein Wortlimit erreicht wird.
curl -X POST https://translator.universally.com/v1/translate/html \
-H "X-API-Key: $UNIVERSALLY_KEY" \
-H "Content-Type: application/json" \
-d '{"html":"<html>...</html>","targetLanguage":"es","sourceUrl":"https://example.com/pricing/"}'
Die Plattform-API
Gleicher Header, anderer Schlüssel: ein Workspace-API-Schlüssel, der mit pak_ beginnt. Er greift auf dieselben Endpunkte zu, die das Dashboard verwendet, sodass er Sprachen hinzufügen, Glossarregeln bearbeiten, gespeicherte Übersetzungen lesen und Websites auflisten kann, ohne dass jemand durch die Benutzeroberfläche klickt.
Erstellen Sie einen unter Workspaces, dann API Keys. Siehe Finden Sie Ihren API-Schlüssel.
Was Sie noch bauen müssen
Das Plugin tut mehr, als einen Endpunkt aufzurufen, und nichts davon ist über die API kostenlos erhältlich:
- Bereitstellung von Sprach-URLs. Etwas muss
/es/pricing/an Ihre spanische Antwort weiterleiten. Universally übersetzt, was Sie senden; es sitzt nicht vor Ihrer Website. - Caching. Einmal übersetzen und das Ergebnis speichern. Das erneute Senden derselben Seite verbraucht keine Wörter mehr, da eine Zeichenfolge nur beim ersten Mal berechnet wird, aber jede Anfrage kostet einen Roundtrip und die damit verbundene Latenz.
- Erkennung von Änderungen. Senden Sie eine Seite erneut, wenn sich ihr Inhalt ändert, sonst sehen Besucher weiterhin die alte Übersetzung.
- Der Sprachumschalter. Das Plugin liefert einen mit. Über die API gehört das Markup Ihnen. Siehe Erstellen Sie einen benutzerdefinierten Sprachumschalter in WordPress für dessen Struktur.