PTC

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.

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_translation

Paramè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

201 Createdapplication/json
{
  "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
422 Unprocessable Entity
{
  "errors": {
    "data": ["Data must be a valid JSON object"]
  }
}
Langues cibles invalides
422 Unprocessable Entity
{
  "errors": {
    "target_languages": ["Language codes [zh, xx] are not configured for this project"]
  }
}
Non autorisé
401 Unauthorized
{
  "error": "Unauthorized access. Please provide a valid API token."
}
Interdit
403 Forbidden
{
  "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 traduit
  • user.settings.theme : « Choose Theme » → Est traduit
  • user.settings.count : 5 → Reste inchangé
  • user.settings.enabled : true → Reste inchangé

Flux de travail de traduction

  1. Validation : La structure JSON et les langues cibles sont vérifiées
  2. Préparation du fichier source : Le JSON est converti dans un format source interne
  3. 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
  4. Mise en file d’attente du travail : Un travail est mis en file d’attente pour chaque langue cible
  5. Traitement : La traduction par IA s’exécute sur les chaînes extraites
  6. Rappel (optionnel) : Un webhook est envoyé lorsque toutes les traductions sont terminées, si un callback_url est 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"

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

200 OKapplication/json
{
  "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
404 Not Found
{
  "error": "Content translation not found"
}
Non autorisé
401 Unauthorized
{
  "error": "Unauthorized access. Please provide a valid API token."
}
Interdit
403 Forbidden
{
  "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"

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}/status

Paramè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

200 OKapplication/json
{
  "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

404 Not Found

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
}