Esplora il centro assistenza

Localizzare un documento markdown tramite API

A cura di Vitalii VlasiukCo-founder

Il markdown è il formato in cui è già scritta la maggior parte dei documenti, degli articoli del centro assistenza e dei contenuti CMS. Invialo all'API così com'è, avvia un workflow per le tue lingue e recupera il markdown per ogni lingua con la struttura intatta.

In questa pagina

Come inviare il markdown?

Invia una richiesta POST /documents con content_type: "markdown" e le tue lingue di destinazione. Transept suddivide il documento in blocchi e crea una versione per ogni lingua di destinazione.

Quindi procedi con la stima e l'esecuzione come descritto in Automatizzare Transept tramite API; l'esecuzione coinvolge tutte le versioni linguistiche con un'unica chiamata.

# BASE="https://app.transept.ai/api/public/v1"; KEY from Settings → Developer
curl -s -X POST $BASE/documents \
  -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{"title": "Getting started", "content_type": "markdown", "source_language": "en",
       "target_languages": ["de", "fr"],
       "content": "# Getting started\n\nInstall the app, then…"}'
# → { document_id, language_group: [ {id, target_language}, … ] }

Come recuperare le traduzioni?

GET /documents/{id}/content?format=markdown per ogni versione linguistica restituisce il markdown renderizzato con la struttura intatta. Gli altri formati (json per la lettura dei singoli blocchi, docx, pdf, xliff, csv) sono elencati nella tabella dei formati di Automatizzare Transept tramite API.

curl -s "$BASE/documents/<de-version-id>/content?format=markdown" \
  -H "Authorization: Bearer $KEY"

Come ritradurre solo ciò che è cambiato?

Se il sorgente viene modificato in un secondo momento, riallinea invece di reimportare: POST /documents/{id}/resync-source mantiene i blocchi invariati (e le relative traduzioni) e contrassegna come obsoleti quelli modificati o aggiunti; un'esecuzione con comportamento only-updated agirà solo su questi ultimi. È il corrispettivo per la prosa del delta basato su chiavi in Localizzare un catalogo di stringhe tramite API; il comportamento generale è descritto in Eseguire solo ciò che è cambiato.

# the source changed? re-align, then run only what went stale
curl -s -X POST $BASE/documents/<master>/resync-source \
  -H "Authorization: Bearer $KEY"
Domande frequenti

La struttura del documento viene mantenuta durante la traduzione?

Sì. Titoli, elenchi, link, enfasi e frammenti di codice vengono mantenuti durante la traduzione e riprodotti nell'esportazione, così il file tradotto si inserisce nella stessa pipeline del sorgente.

Devo pagare di nuovo se rieseguo un documento invariato?

No. Con il comportamento only-updated, un'esecuzione interviene solo sui blocchi il cui sorgente è cambiato dall'ultima esecuzione. Rieseguire un documento invariato non costa nulla, e una piccola modifica costa solo pochi blocchi.

Ha ancora dubbi? Chieda a Literess nell'app, oppure scriva a [email protected].