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 <AUTHENTICATION_TOKEN

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

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.

Points de terminaison concernés

• POST /api/v1/source_files – Créer les fichiers source
• PUT /api/v1/source_files/process – Traiter les fichiers source
• POST /api/v1/source_files/bulk – Télécharger des fichiers source en masse

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

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

Statut : 429 too many requests
{
 "error": "rate limit exceeded"
}

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

Catégories d’API disponibles