La API de PTC utiliza REST y le permite integrar la localización de software en su proceso de desarrollo. Los endpoints de la API le permiten añadir y actualizar archivos fuente, recuperar información, gestionar traducciones y mucho más.
La API de PTC solo se puede utilizar en modo activo. Admite métodos HTTP estándar y devuelve respuestas con formato JSON. La autenticación se basa en tokens y es específica del proyecto.
Fragmentos de código
Ruby
Python
PHP
Java
Go
.NET
Node.js
JavaScript (jQuery)
La documentación utiliza cURL para mostrar cómo realizar solicitudes HTTP a la API de PTC, pero puede cambiar para ver diferentes ejemplos en el código.
Autenticación
Para empezar:
- Inicie sesión en su cuenta de PTC. Si aún no tiene una, inicie una prueba gratuita.
- Al configurar su proyecto, elija la opción Integración de API. Después de proporcionar a PTC algo de contexto sobre su proyecto, recibirá un token de API.
- Siempre puede recuperar su token desde Ajustes → Tokens de la API de PTC en su panel de control de PTC.
Todas las solicitudes a la API de PTC requieren autenticación mediante un token que le da acceso a un único proyecto en PTC.
Incluya el token en el encabezado de autorización de cada solicitud utilizando el formato
Bearer <AUTHENTICATION_TOKEN>Códigos de respuesta
La API de PTC utiliza códigos de respuesta HTTP estándar para indicar el éxito o el fracaso de una solicitud.
Resumen de códigos de estado HTTP
200
OK
La solicitud funcionó como se esperaba.
401
No autorizado
No se proporcionó ningún token de API válido. Compruebe si su token es correcto, no ha caducado y está incluido en el encabezado Authorization.
Limitación de velocidad
La API de PTC implementa la limitación de velocidad para garantizar un uso justo y mantener la calidad del servicio. Los límites se aplican por organización y se rastrean en operaciones API específicas.
| Tipo de límite | Solicitudes | Plazo | Ámbito |
| Operaciones de archivo | 10 | 1 minuto | Por organización |
Endpoints afectados
POST /api/v1/source_files– Crear los archivos fuentePUT /api/v1/source_files/process– Procesar los archivos fuentePOST /api/v1/source_files/bulk– Cargar archivos fuente de forma masiva
Cuando se superan los límites de velocidad
Si una solicitud supera la velocidad permitida, la API devuelve:
Status: 429 Too Many Requests
{
"error": "Rate limit exceeded"
}Categorías de API disponibles
Cargue y gestione los archivos de origen a través de la API
Utilice estos endpoints para cargar, reemplazar y organizar sus archivos fuente. Esto incluye:
- Cargar un solo archivo o cargar de forma masiva varios archivos en un archivo ZIP
- Reemplazar o actualizar un archivo fuente existente con contenido nuevo
- Listar archivos con opciones de filtrado, ordenación y paginación
Obtenga formatos de archivo compatibles e idiomas de destino a través de la API
Utilice estos endpoints para comprobar:
- Los códigos ISO correctos que debe utilizar al crear trabajos de traducción o cargar traducciones
- Qué idiomas admite su proyecto
- Todas las extensiones de archivo fuente que puede cargar en PTC, junto con cualquier archivo de traducción adicional que PTC pueda generar para esas entradas
Solicite y recupere traducciones a través de la API
Utilice estos endpoints para enviar contenido para su traducción, realizar un seguimiento de su progreso y recuperar traducciones. Esto incluye:
- Crear trabajos de traducción para contenido estructurado en JSON
- Comprobar el estado de los trabajos de traducción
- Recuperar traducciones completadas
Integre la localización en su canalización de CI/CD con la API de PTC
Utilice esta guía para automatizar las traducciones como parte de su proceso de compilación. Esto incluye:
- Configurar PTC con GitHub Actions, GitLab CI/CD u otros sistemas CI/CD utilizando archivos de configuración listos para usar
- Ejecutar traducciones de forma automática y segura durante cada compilación
