API: Übersetzungen importieren

Du kannst die Haiilo-API verwenden, um benutzerdefinierte Übersetzungen hinzuzufügen. Während du die Standardübersetzungen immer direkt auf der Plattform bearbeiten kannst, ist die Verwendung der API erforderlich, um Übersetzungen für z.B. neue von dir erstellte Profilfelder hinzuzufügen.

Außerdem musst du, falls du eine Sprache verwendest, für die Haiilo keine Standardübersetzungen bereitstellt, die Übersetzungen selbst in großen Mengen bereitstellen. Anstatt sie manuell in den Plattformeinstellungen einzugeben, kannst du die API nutzen, um die Aufgabe für dich zu erleichtern.

Um Anfragen an die Haiilo-API zu stellen, musst du dich zuerst authentifizieren. Detaillierte Informationen zur Authentifizierung und Verwendung der API findest du hier.

Alle aktivierten Sprachen auflisten

Du kannst deine aktivierten Sprachen auf der Plattform unter Administration > Sprachen anzeigen oder mit dem folgenden API-Aufruf.

Führe einen GET-Aufruf an den Endpunkt /api/languages aus.

Die Antwort sollte wie folgt aussehen, wenn du Englisch, Deutsch und Französisch aktiviert hast:

[
    {
        "language": "DE",
        "active": true,
        "defaultLanguage": false
    },
    {
        "language": "EN",
        "active": true,
        "defaultLanguage": true
    },
    {
        "language": "FR",
        "active": true,
        "defaultLanguage": false
    }
]

Sprache aktivieren

Du kannst Sprachen auf der Plattform unter Administration > Sprachen aktivieren oder mit dem folgenden API-Aufruf.

Starte eine neue Anfrage
Gib das Folgende im Anfrage-Body ein
```
{
  "active": true
}
```
Führe einen PUT-Aufruf an den Endpunkt /api/languages/<language> aus, wobei <language> der Sprachtag in Großbuchstaben der spezifischen Sprache ist, die du aktivieren möchtest. Z.B. ES für Spanisch

Übersetzung hinzufügen

Die folgenden Schritte hängen davon ab, ob du eine völlig neue Übersetzung erstellst oder eine frühere Übersetzung ersetzt.

Neue Übersetzung erstellen

Starte eine neue Anfrage

Gib das Folgende im Anfrage-Body ein

{
  "value":"<translation>",
  "bundle":"<bundle>"
}

Ersetze die Platzhalter wie folgt:
- <language>: Der Sprachtag in Kleinbuchstaben der spezifischen Sprache, die du bearbeiten möchtest. Z.B. en für Englisch
- <language_key>: Der Name des Sprachschlüssels, den du anpassen möchtest. Z.B. ein neues Benutzerprofilfeld namens roomnumber könnte den Schlüssel USER.ROOMNUMBER haben
- <translation>: Die neue Übersetzung, die du für den Sprachschlüssel hinzufügen möchtest. Z.B. für das Feld roomnumber auf Englisch könnten wir "Raumnummer" als Übersetzung auswählen.
- <bundle>: Entweder "frontend" oder "backend"
Führe einen POST-Aufruf an den Endpunkt /web/i18n/overrides/<language>/translations/<language_key> aus, um eine neue Übersetzung zu importieren
Wiederhole dies für das andere Bundle, falls erforderlich.

Übersetzung ersetzen

Erstelle eine neue Anfrage

Gib Folgendes in den Anfrage-Body ein

{
  "value":"<Übersetzung>",
  "bundle":"<Bundle>"
}

Ersetze die Platzhalter (siehe oben für Platzhalter-Definitionen)
Führe einen PUT-Request an den Endpunkt /web/i18n/overrides/<Sprache>/translations/<Sprachschlüssel> aus, um eine vorhandene Übersetzung anzupassen

Eine Übersetzung löschen

Ersetze die Platzhalter (siehe oben für Platzhalter-Definitionen)
Führe einen DELETE-Request an den Endpunkt /web/i18n/overrides/<Sprache>/translations/<Bundle>/<Sprachschlüssel> aus, um eine vorhandene Übersetzung zu löschen

Deine benutzerdefinierten Übersetzungen auflisten

Führe einen GET-Request an den Endpunkt /web/i18n/overrides/public/<Sprache>/translations aus, um deine vorhandenen Übersetzungen anzuzeigen
Ersetze <Sprache> durch den Sprachtag in Kleinbuchstaben der spezifischen Sprache, für die du die Übersetzungen sehen möchtest. Z.B. en für Englisch

Die Antwort zeigt die Sprachschlüssel an, für die du benutzerdefinierte Übersetzungen hinzugefügt hast, entweder über die API oder in der Plattform.