Demander et récupérer des traductions via l’API
Utilisez cette API pour envoyer du contenu à traduire, suivre sa progression et récupérer les traductions dans toutes les langues cibles.
Cette API accepte du contenu structuré en JSON, préservant la structure et les clés d’origine. Elle ne traduit que les valeurs textuelles, laissant les nombres, les booléens, les valeurs nulles et les autres valeurs non textuelles inchangés.
Liens rapides de l’API
- Créer des traductions de contenu
- Récupérer des traductions de contenu
- Obtenir le statut de traduction du contenu
Créer des traductions de contenu
Crée un nouveau travail de traduction à partir de données structurées en JSON.
Le point de terminaison préserve la hiérarchie d’origine de vos clés et tableaux, en ne traduisant que les valeurs textuelles tout en laissant les nombres, les booléens, les valeurs nulles et les autres valeurs non textuelles inchangés.
C’est particulièrement utile pour :
- La gestion de contenu – Localiser du contenu dynamique structuré en JSON
- Les fichiers de configuration – Traduire les chaînes destinées aux utilisateurs dans les données de configuration
- Les réponses d’API – Traduire des charges utiles de réponse structurées
- La documentation – Localiser du contenu d’aide ou des guides hiérarchiques
Pour une implémentation Rails complète de ce flux de travail, consultez Traduire du contenu dynamique dans Rails à l’aide de l’API PTC.
Requête HTTP
POST https://app.ptc.wpml.org/api/v1/content_translationParamètres
| Paramètre | Type | Requis | Description |
|---|---|---|---|
data |
object | Oui | Les données structurées en JSON à traduire. Elles peuvent inclure des objets imbriqués, des tableaux et des valeurs de type chaîne. |
name |
string | Non | Un nom lisible par l’homme pour le travail de traduction. S’il est omis, un nom est généré automatiquement. |
callback_url |
string | Non | L’URL qui reçoit les notifications par webhook lorsque la traduction est terminée. |
target_languages |
array[string] | Non | Le tableau des codes ISO pour les langues cibles. S’il est omis, les traductions sont créées pour toutes les langues configurées dans le projet. Consultez l’API des langues cibles disponibles pour plus d’informations. |
Exemple de corps de requête
{
"data": {
"app": {
"title": "My Application",
"navigation": {
"home": "Home",
"about": "About Us",
"contact": "Contact"
},
"buttons": {
"save": "Save",
"cancel": "Cancel",
"submit": "Submit"
},
"messages": {
"welcome": "Welcome to our platform",
"error": "An error occurred"
}
},
"version": "1.0.0",
"settings": {
"theme": "dark",
"notifications": true
}
},
"name": "App UI Translations",
"callback_url": "https://your-app.com/webhooks/translation-complete",
"target_languages": ["es", "fr", "de"]
}Réponses
Réponse de succès
{
"id": 123,
"name": "App UI Translations",
"status": "queued",
"created_at": "2024-01-15T10:30:00.000Z",
"updated_at": "2024-01-15T10:30:00.000Z"
}Schéma de réponse
| Champ | Type | Description |
|---|---|---|
id |
number | L’identifiant unique du travail de traduction de contenu. |
name |
string | Le nom du travail (généré automatiquement s’il n’est pas fourni). |
status |
string | Le statut actuel du travail (queued, processing, completed). |
created_at |
string | L’horodatage ISO 8601 indiquant quand le travail a été créé. |
updated_at |
string | L’horodatage ISO 8601 indiquant quand le travail a été mis à jour pour la dernière fois. |
Réponses d’erreur
Données JSON invalides
{
"errors": {
"data": ["Data must be a valid JSON object"]
}
}Langues cibles invalides
{
"errors": {
"target_languages": ["Language codes [zh, xx] are not configured for this project"]
}
}Non autorisé
{
"error": "Unauthorized access. Please provide a valid API token."
}Interdit
{
"error": "Access denied. Insufficient permissions."
}Traitement des données JSON
Lorsqu’il travaille avec des données structurées en JSON, PTC traite les données comme suit :
- La structure est préservée – La hiérarchie d’origine des clés et l’imbrication restent inchangées
- Seules les chaînes sont traduites – Les nombres, les booléens, les tableaux et les valeurs nulles sont conservés tels quels
- Traduction basée sur le chemin – Chaque chaîne traduisible est identifiée par son chemin JSON
- Prise en charge de l’imbrication – Fonctionne avec des objets et des tableaux profondément imbriqués
- Gère les types de données mixtes – Les valeurs qui ne sont pas des chaînes sont préservées sans modification
Exemple de transformation de données
Entrée :
{
"user": {
"name": "Welcome User",
"settings": {
"theme": "Choose Theme",
"count": 5,
"enabled": true
}
}
}Résultat du traitement :
user.name: « Welcome User » → Est traduituser.settings.theme: « Choose Theme » → Est traduituser.settings.count :5 → Reste inchangéuser.settings.enabled :true → Reste inchangé
Flux de travail de traduction
- Validation : La structure JSON et les langues cibles sont vérifiées
- Préparation du fichier source : Le JSON est converti dans un format source interne
- Réutilisation des chaînes via la mémoire de traduction : Toutes les chaînes traduisibles sont extraites et stockées dans la mémoire de traduction de votre projet afin que les traductions précédentes puissent être réutilisées
- Mise en file d’attente du travail : Un travail est mis en file d’attente pour chaque langue cible
- Traitement : La traduction par IA s’exécute sur les chaînes extraites
- Rappel (optionnel) : Un webhook est envoyé lorsque toutes les traductions sont terminées, si un
callback_urlest fourni
Rappel par webhook
Lorsqu’un callback_url est fourni, une requête POST est envoyée une fois le travail terminé.
Corps de la requête de rappel :
{
"id": 1,
"status": "completed",
"translations_url": "https://app.ptc.wpml.org/api/v1/content_translation/1"
}Types de données pris en charge
| Type JSON | Comportement de traduction |
|---|---|
string |
Traduit dans les langues cibles |
number |
Préservé tel quel |
boolean |
Préservé tel quel |
null |
Préservé tel quel |
array |
Traité de manière récursive |
object |
Traité de manière récursive |
Exemples de requêtes
Traduction JSON de base :
curl -X POST "https://app.ptc.wpml.org/api/v1/content_translation" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"data": {
"welcome": "Welcome",
"buttons": {
"save": "Save",
"cancel": "Cancel"
}
},
"name": "UI Labels"
}'Avec des langues cibles spécifiques :
curl -X POST "https://app.ptc.wpml.org/api/v1/content_translation" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"data": {
"title": "Product Catalog",
"categories": {
"electronics": "Electronics",
"clothing": "Clothing"
}
},
"target_languages": ["es", "fr"],
"callback_url": "https://myapp.com/webhook"
}'Exemples de code
curl -X POST "https://app.ptc.wpml.org/api/v1/content_translation" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"data":{"app":{"title":"My Application","navigation":{"home":"Home","about":"About Us"}}},"name":"App Translations","target_languages":["es","fr","de"],"callback_url":"https://your-app.com/webhooks/complete"}'
# The response includes the job "id". Poll its status (status stays
# "in_progress" until done — it is not set on the create response):
curl -X GET "https://app.ptc.wpml.org/api/v1/content_translation/CONTENT_TRANSLATION_ID/status" \
-H "Authorization: Bearer YOUR_API_TOKEN"require 'net/http'
require 'uri'
require 'json'
uri = URI('https://app.ptc.wpml.org/api/v1/content_translation')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request['Content-Type'] = 'application/json'
request.body = {
data: { app: { title: 'My Application',
navigation: { home: 'Home', about: 'About Us' } } },
name: 'App Translations',
target_languages: %w[es fr de],
callback_url: 'https://your-app.com/webhooks/complete'
}.to_json
response = http.request(request)
id = JSON.parse(response.body)['id']
puts "Translation job created with ID: #{id}"
# Poll the status endpoint for progress (status is set there, not on create)
status_uri = URI("https://app.ptc.wpml.org/api/v1/content_translation/#{id}/status")
status_request = Net::HTTP::Get.new(status_uri)
status_request['Authorization'] = 'Bearer YOUR_API_TOKEN'
status = JSON.parse(http.request(status_request).body)
puts "Status: #{status['status']} (#{status['completeness']}% complete)"import requests
headers = {
'Authorization': 'Bearer YOUR_API_TOKEN',
'Content-Type': 'application/json'
}
payload = {
"data": {"app": {"title": "My Application",
"navigation": {"home": "Home", "about": "About Us"}}},
"name": "App Translations",
"target_languages": ["es", "fr", "de"],
"callback_url": "https://your-app.com/webhooks/complete"
}
response = requests.post('https://app.ptc.wpml.org/api/v1/content_translation', headers=headers, json=payload)
translation_id = response.json()['id']
print(f"Translation job created with ID: {translation_id}")
# Poll the status endpoint for progress (status is set there, not on create)
status_response = requests.get(f'https://app.ptc.wpml.org/api/v1/content_translation/{translation_id}/status', headers=headers)
status = status_response.json()
print(f"Status: {status['status']} ({status['completeness']}% complete)")<?php
$payload = [
'data' => ['app' => ['title' => 'My Application',
'navigation' => ['home' => 'Home', 'about' => 'About Us']]],
'name' => 'App Translations',
'target_languages' => ['es', 'fr', 'de'],
'callback_url' => 'https://your-app.com/webhooks/complete'
];
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://app.ptc.wpml.org/api/v1/content_translation',
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => json_encode($payload),
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_API_TOKEN',
'Content-Type: application/json'
],
]);
$response = curl_exec($curl);
curl_close($curl);
$id = json_decode($response, true)['id'];
echo "Translation job created with ID: " . $id . "\n";
// Poll the status endpoint for progress (status is set there, not on create)
$statusCurl = curl_init();
curl_setopt_array($statusCurl, [
CURLOPT_URL => "https://app.ptc.wpml.org/api/v1/content_translation/{$id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_TOKEN'],
]);
$status = json_decode(curl_exec($statusCurl), true);
curl_close($statusCurl);
echo "Status: " . $status['status'] . " (" . $status['completeness'] . "% complete)";
?>import okhttp3.*;
OkHttpClient client = new OkHttpClient();
MediaType JSON = MediaType.parse("application/json");
String payload = "{"
+ "\"data\":{\"app\":{\"title\":\"My Application\",\"navigation\":{\"home\":\"Home\",\"about\":\"About Us\"}}},"
+ "\"name\":\"App Translations\",\"target_languages\":[\"es\",\"fr\",\"de\"],"
+ "\"callback_url\":\"https://your-app.com/webhooks/complete\"}";
Request request = new Request.Builder()
.url("https://app.ptc.wpml.org/api/v1/content_translation")
.addHeader("Authorization", "Bearer YOUR_API_TOKEN")
.post(RequestBody.create(payload, JSON))
.build();
Response response = client.newCall(request).execute();
System.out.println(response.body().string());package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
payload := []byte(`{
"data": {"app": {"title": "My Application",
"navigation": {"home": "Home", "about": "About Us"}}},
"name": "App Translations",
"target_languages": ["es", "fr", "de"],
"callback_url": "https://your-app.com/webhooks/complete"
}`)
req, _ := http.NewRequest("POST", "https://app.ptc.wpml.org/api/v1/content_translation", bytes.NewBuffer(payload))
req.Header.Add("Authorization", "Bearer YOUR_API_TOKEN")
req.Header.Add("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}
using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Text;
var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", "YOUR_API_TOKEN");
var payload = @"{
""data"": {""app"": {""title"": ""My Application"",
""navigation"": {""home"": ""Home"", ""about"": ""About Us""}}},
""name"": ""App Translations"",
""target_languages"": [""es"", ""fr"", ""de""],
""callback_url"": ""https://your-app.com/webhooks/complete""
}";
var body = new StringContent(payload, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://app.ptc.wpml.org/api/v1/content_translation", body);
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);const axios = require('axios');
const payload = {
data: {
app: {
title: "My Application",
navigation: { home: "Home", about: "About Us" }
}
},
name: "App Translations",
target_languages: ["es", "fr", "de"],
callback_url: "https://your-app.com/webhooks/complete"
};
const response = await axios.post('https://app.ptc.wpml.org/api/v1/content_translation', payload, {
headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});
const translationId = response.data.id;
console.log('Translation job created with ID:', translationId);
// Poll the status endpoint for progress (status is set there, not on create)
const status = await axios.get(`https://app.ptc.wpml.org/api/v1/content_translation/${translationId}/status`, {
headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});
console.log(`Status: ${status.data.status} (${status.data.completeness}% complete)`);Récupérer des traductions de contenu
Récupère le contenu d’origine et toutes les versions traduites pour un travail de traduction de contenu spécifique.
La réponse préserve votre structure d’entrée : elle renvoie un objet source plus un objet par langue cible (identifié par le code de langue tel que es, fr, de).
Requête HTTP
GET https://app.ptc.wpml.org/api/v1/content_translation/{id}Paramètres de chemin
| Paramètre | Type | Requis | Description |
|---|---|---|---|
id |
integer | Oui | L’identifiant unique du travail de traduction de contenu à récupérer. |
Réponses
Réponse de succès
{
"source": {
"app": {
"title": "My Application",
"navigation": {
"home": "Home",
"about": "About",
"contact": "Contact"
},
"buttons": {
"save": "Save",
"cancel": "Cancel"
}
}
},
"es": {
"app": {
"title": "Mi Aplicación",
"navigation": {
"home": "Inicio",
"about": "Acerca de",
"contact": "Contacto"
},
"buttons": {
"save": "Guardar",
"cancel": "Cancelar"
}
}
},
"fr": {
"app": {
"title": "Mon Application",
"navigation": {
"home": "Accueil",
"about": "À propos",
"contact": "Contact"
},
"buttons": {
"save": "Enregistrer",
"cancel": "Annuler"
}
}
}
}Schéma de réponse
| Champ | Type | Description |
|---|---|---|
source |
object | Le contenu source d’origine dans la même structure imbriquée que celle soumise. |
{language_code} |
object | Le contenu traduit pour chaque langue cible, identifié par son code ISO (par exemple es, fr, de), avec la même structure que la source. Pour plus d’informations, consultez l’API des langues cibles disponibles. |
Réponses d’erreur
Traduction de contenu non trouvée
{
"error": "Content translation not found"
}Non autorisé
{
"error": "Unauthorized access. Please provide a valid API token."
}Interdit
{
"error": "Access denied. Insufficient permissions."
}Exemples de requêtes
Requête de base :
curl -X GET "https://app.ptc.wpml.org/api/v1/content_translation/123" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json"Exemples de code
curl -X GET "https://app.ptc.wpml.org/api/v1/content_translation/123" \
-H "Authorization: Bearer YOUR_API_TOKEN"require 'net/http'
require 'uri'
uri = URI('https://app.ptc.wpml.org/api/v1/content_translation/123')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
require 'json'
data = JSON.parse(response.body)
puts "Source: #{data['source']}"
data.each { |lang, translation| puts "#{lang}: #{translation}" unless lang == 'source' }import requests
headers = {
'Authorization': 'Bearer YOUR_API_TOKEN'
}
response = requests.get('https://app.ptc.wpml.org/api/v1/content_translation/123', headers=headers)
data = response.json()
print('Source:', data['source'])
for lang_code, translation in data.items():
if lang_code != 'source':
print(f"{lang_code}:", translation)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://app.ptc.wpml.org/api/v1/content_translation/123',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_API_TOKEN'
],
]);
$response = curl_exec($curl);
curl_close($curl);
$data = json_decode($response, true);
foreach ($data as $langCode => $translation) {
echo strtoupper($langCode) . ": " . json_encode($translation) . "\n";
}
?>import okhttp3.*;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://app.ptc.wpml.org/api/v1/content_translation/123")
.addHeader("Authorization", "Bearer YOUR_API_TOKEN")
.build();
Response response = client.newCall(request).execute();
System.out.println(response.body().string());package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://app.ptc.wpml.org/api/v1/content_translation/123", nil)
req.Header.Add("Authorization", "Bearer YOUR_API_TOKEN")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}
using System;
using System.Net.Http;
using System.Threading.Tasks;
var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", "YOUR_API_TOKEN");
var response = await client.GetAsync("https://app.ptc.wpml.org/api/v1/content_translation/123");
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);const axios = require('axios');
const response = await axios.get('https://app.ptc.wpml.org/api/v1/content_translation/123', {
headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});
const data = response.data;
console.log('Source:', data.source);
Object.keys(data).forEach(lang => {
if (lang !== 'source') console.log(`${lang}:`, data[lang]);
});Obtenir le statut de traduction du contenu
Récupère le statut actuel d’un travail de traduction de contenu spécifique.
La réponse reflète la progression globale et indique si la traduction est en file d’attente, en cours, terminée ou si elle a échoué.
Requête HTTP
GET https://app.ptc.wpml.org/api/v1/content_translation/{id}/statusParamètres de chemin
| Paramètre | Type | Requis | Description |
|---|---|---|---|
id |
integer | Oui | L’identifiant unique du travail de traduction de contenu à vérifier. |
Réponses
Réponse de succès
{
"status": "completed",
"completeness": 100
}Schéma de réponse
| Champ | Type | Description |
|---|---|---|
status |
string | Le statut actuel de la traduction. Les valeurs de statut possibles incluent : queued, in_progress, completed, failed, status_unknown. |
completeness |
number | Le pourcentage de chaînes traduites (0–100). Calculé comme suit : (completed_translatable_strings / total_translatable_strings) × 100. |
Valeurs de statut
| Statut | Description |
|---|---|
queued |
La traduction a été mise en file d’attente et attend d’être traitée. |
in_progress |
La traduction est actuellement en cours de traitement. |
completed |
La traduction a été terminée avec succès. |
failed |
La traduction a échoué en raison d’une erreur. |
status_unknown |
Le statut de la traduction est inconnu ou ne peut pas encore être déterminé. |
Réponses d’erreur
Causes possibles :
- Aucune traduction de contenu n’existe avec l’identifiant spécifié
- Le travail de traduction n’appartient pas au projet authentifié
Exemple
curl -X GET "https://app.ptc.wpml.org/api/v1/content_translation/123/status" \
-H "Authorization: Bearer YOUR_API_TOKEN"Réponse :
{
"status": "completed",
"completeness": 100
}Réponse pendant que le travail est toujours en cours :
{
"status": "in_progress",
"completeness": 70
}{
"status": "completed",
"completeness": 100
}