Ferndesk

Artikelübersetzungen

Übersetzung erstellen oder aktualisieren

Stellt einen Übersetzungsentwurf für ein Locale bereit. Übergeben Sie publish: true, um ihn sofort zu veröffentlichen. Erfordert den Scope content:write (für die Veröffentlichung muss der Entwurf außerdem gültig sein).

Erforderlicher Scope: content:write

PUT /articles/{id}/translations/{locale}

Übersetzung erstellen oder aktualisieren

curl --request PUT \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/translations/{LOCALE}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "articleId": "<string>",
  "language": "<string>",
  "draftId": "<string>",
  "published": true
}

Als Entwurf gespeicherte/veröffentlichte Übersetzung

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Schlüssel beginnen mit fdsk_ und sollten geheim gehalten werden. Schlüssel können auf der Seite Entwicklereinstellungen erstellt und verwaltet werden.

    Schlüssel können auf jede Teilmenge der folgenden Scopes beschränkt werden (jeder Endpunkt listet den erforderlichen Scope über x-required-scopes auf):

    • content:read: Hilfecenter-Artikel, Sammlungen, Abschnitte und Übersetzungen lesen und durchsuchen
    • content:write: Artikelentwürfe, Benutzer und Aufgaben erstellen und bearbeiten; Artikel und Sammlungen verschieben
    • content:publish: Inhalte veröffentlichen, deren Veröffentlichung aufheben, wiederherstellen und löschen (Änderungen live schalten)
    • analytics:read: Berichte, Analysen und Artikel-Feedback des Hilfecenters lesen
    • conversations:read: Unterhaltungen und Transkripte des KI-Assistenten lesen
    • webhooks:manage: Ausgehende Webhook-Abonnements erstellen und verwalten

    Die Vergabe von content:write oder content:publish beinhaltet content:read. Vor der Einführung von Scopes erstellte Schlüssel haben null Scopes = vollständiger Zugriff (Legacy-Modus).

Path Parameters

  • id string erforderlich

    Ressourcen-ID der angeforderten Entität. Beispiel: art_01JXY9AZK4KV

  • locale string erforderlich

    Locale-Code für die abzurufende Übersetzung. Beispiel: en

Request Body

application/json
  • title string
  • content any

    JSON-Dokument-Payload. Für Artikel handelt es sich typischerweise um ein Rich-Text-Objekt im Stil von ProseMirror/Tiptap. src-Werte von Bildknoten können Ferndesk-Asset-Pfade, externe Bild-URLs oder data:image/...;base64,...-Werte sein; externe URLs und Base64-Bilder werden beim Schreiben hochgeladen und in Ferndesk-Asset-Pfade umgeschrieben.

  • markdown string
  • publish boolean default

    Die Übersetzung unmittelbar nach dem Speichern als Entwurf veröffentlichen. Default: false.

Response

application/json
  • articleId string

    Artikel, zu dem die Übersetzung gehört.

  • language string

    Übersetzungs-Locale.

  • draftId string

    ID des Übersetzungsentwurfs.

  • published boolean

    Gibt an, ob die Übersetzung veröffentlicht wurde (true) oder nur als Entwurf gespeichert wurde (false).