Référence de l’API PTC

L’API PTC utilise REST et vous permet d’intégrer la localisation de logiciels dans votre processus de développement. Les points de terminaison de l’API vous permettent d’ajouter et de mettre à jour des fichiers source, de récupérer des informations, de gérer les traductions, et bien plus encore.

L’API PTC ne peut être utilisée qu’en mode direct. Elle prend en charge les méthodes HTTP standard et renvoie des réponses au format JSON. L’authentification est basée sur des jetons et spécifique au projet.

Extraits de code

Ruby

Python

PHP

Java

Go

.NET

Node.js

JavaScript (jQuery)

La documentation utilise cURL pour montrer comment effectuer des requêtes HTTP à l’API PTC, mais vous pouvez basculer pour voir différents exemples de code.

Authentification

Pour commencer :

  1. Connectez-vous à votre compte PTC. Si vous n’en avez pas encore, démarrez un essai gratuit.
  2. Lors de la configuration de votre projet, choisissez l’option Intégration API. Après avoir fourni à PTC un contexte concernant votre projet, vous recevrez un jeton API.
  3. Vous pouvez toujours récupérer votre jeton dans Paramètres → Jetons API PTC dans votre tableau de bord PTC.

Toutes les requêtes à l’API PTC nécessitent une authentification à l’aide d’un jeton qui vous donne accès à un seul projet dans PTC.

Incluez le jeton dans l’en-tête d’autorisation de chaque requête en utilisant le format Bearer :

Bearer <AUTHENTICATION_TOKEN>

Codes de réponse

L’API PTC utilise les codes de réponse HTTP standard pour indiquer le succès ou l’échec d’une requête.

Résumé des codes d’état HTTP

200

OK

La requête a fonctionné comme prévu.


401

Non autorisé

Aucun jeton API valide n’a été fourni. Vérifiez si votre jeton est correct, s’il n’a pas expiré et s’il est inclus dans l’en-tête Authorization.

Limitation du débit

L’API PTC met en œuvre une limitation du débit pour garantir une utilisation équitable et maintenir la qualité du service. Les limites sont appliquées par organisation et suivies pour des opérations API spécifiques.

Type de limiteRequêtesPériodePortée
Opérations sur les fichiers101 minutePar organisation

Points de terminaison concernés

Lorsque les limites de débit sont dépassées

Si une requête dépasse le débit autorisé, l’API renvoie :

Status: 429 Too Many Requests
{
  "error": "Rate limit exceeded"
}

Catégories d’API disponibles

Téléchargez et gérez les fichiers source via l’API

Utilisez ces points de terminaison pour télécharger, remplacer et organiser vos fichiers source. Cela comprend :

  • Télécharger un seul fichier ou télécharger en masse plusieurs fichiers dans une archive ZIP
  • Remplacer ou mettre à jour un fichier source existant avec un nouveau contenu
  • Répertorier les fichiers avec des options de filtrage, de tri et de pagination

Accéder à l’outil de chargement et de gestion des fichiers sources →

Obtenir les formats de fichiers pris en charge et les langues cibles via l’API

Utilisez ces points de terminaison pour vérifier :

  • Les codes ISO corrects à utiliser lors de la création de tâches de traduction ou du téléchargement de traductions
  • Les langues prises en charge par votre projet
  • Toutes les extensions de fichiers source que vous pouvez télécharger sur PTC, ainsi que tous les fichiers de traduction supplémentaires que PTC peut générer pour ces entrées

Accéder aux formats de fichiers disponibles et aux langues cibles →

Demandez et récupérez les traductions via l’API

Utilisez ces points de terminaison pour soumettre du contenu à traduire, suivre sa progression et récupérer les traductions. Cela comprend :

  • Créer des tâches de traduction pour le contenu structuré en JSON
  • Vérifier l’état des tâches de traduction
  • Récupérer les traductions terminées

Accéder à l’outil de demande et de récupération des traductions →

Intégrez la localisation dans votre pipeline CI/CD avec l’API PTC

Utilisez ce guide pour automatiser les traductions dans le cadre de votre processus de construction. Cela comprend :

  • La configuration de PTC avec GitHub Actions, GitLab CI/CD ou d’autres systèmes CI/CD à l’aide de fichiers de configuration prêts à l’emploi
  • L’exécution des traductions automatiquement et en toute sécurité à chaque construction

Accéder à l’intégration CI/CD →

Faire défiler vers le haut