Ferndesk

Artikelübersetzungen

Artikelübersetzung abrufen

Gibt die lokalisierte Version eines Artikels für ein bestimmtes Gebietsschema zurück. Verwenden Sie format=markdown für Markdown. Erfordert den Scope content:read.

Erforderlicher Scope: content:read

GET /articles/{id}/translations/{locale}

Artikelübersetzung abrufen

curl --request GET \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/translations/{LOCALE}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "articleId": "<string>",
  "language": "<string>",
  "title": "<string>",
  "contentHtml": "<string>",
  "contentMarkdown": "<string>",
  "contentJson": "<string>",
  "url": "<url>",
  "status": "<string>",
  "updatedAt": "<string>"
}

Artikelübersetzung

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Schlüssel beginnen mit fdsk_ und müssen geheim gehalten werden. Sie können Schlüssel auf der Seite Entwicklereinstellungen erstellen und verwalten.

    Schlüssel können auf eine beliebige Teilmenge dieser Scopes beschränkt werden (jeder Endpunkt gibt den über x-required-scopes erforderlichen Scope an):

    • content:read: Hilfezentrumsartikel, 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, die Veröffentlichung aufheben, wiederherstellen und in den Papierkorb verschieben (Änderungen live schalten)
    • analytics:read: Berichte, Analysen und Artikel-Feedback des Hilfezentrums 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

    Gebietsschema-Code der abzurufenden Übersetzung. Beispiel: en

Query Parameters

  • format string enum

    Format zur Darstellung des Inhalts. html (Standard) gibt contentHtml zurück; markdown gibt contentMarkdown zurück; json gibt contentJson zurück – das unveränderte gespeicherte ProseMirror/Tiptap-Dokument. Das JSON verwendet das ProseMirror-Schema von Ferndesk (benutzerdefinierte Knoten wie callout, steps und cards) und ist die verlustfreie Darstellung des Artikelinhalts. Beispiel: markdown

Response

application/json
  • articleId string

    Artikel-ID von Ferndesk (art_...).

  • language string

    Sprachcode dieser Übersetzung.

  • title string

    Lokalisierter Artikeltitel.

  • contentHtml string

    Lokalisierter Artikelinhalt, als HTML gerendert. Vorhanden, wenn format=html (Standard) verwendet wird.

  • contentMarkdown string

    Lokalisierter Artikelinhalt, als Markdown gerendert. Vorhanden, wenn format=markdown verwendet wird.

  • contentJson any | null

    Rohes gespeichertes ProseMirror/Tiptap-Dokument. Vorhanden, wenn format=json verwendet wird. Verwendet das ProseMirror-Schema von Ferndesk (benutzerdefinierte Knoten wie callout, steps und cards) und ist die verlustfreie Darstellung.

  • url string (uri) | null

    Kanonische öffentliche URL für diesen übersetzten Artikel.

  • status string

    Status des Übersetzungslebenszyklus.

  • updatedAt string

    ISO-8601-Zeitstempel in UTC.