PTC

Cargar y gestionar archivos de origen mediante la API

Utilice esta API para cargar nuevos archivos de origen, sustituir los obsoletos, realizar un seguimiento del progreso de la traducción y descargar las traducciones completadas.

Tanto si gestiona un único archivo como si automatiza un flujo de trabajo de localización continua, esta API le ofrece un control total sobre el contenido que envía a traducir y sobre cómo recibe las traducciones.

Cómo identifica y organiza la API de PTC los archivos de origen

La API de PTC utiliza un sistema flexible basado en etiquetas de archivo y rutas de archivo. Estos parámetros funcionan conjuntamente para garantizar que cada archivo que usted suba, actualice o solicite esté claramente definido y sea fácil de gestionar.

Etiquetas de archivo

Las etiquetas de archivo son una forma flexible de agrupar y organizar los archivos de origen en los proyectos de traducción. Puede utilizarlas como categorías para adaptarlas a las necesidades de su flujo de trabajo. Por ejemplo, las etiquetas de archivo pueden indicar:

  • Control de versiones: v1.0, beta, production
  • Ramas de funciones: user-auth, dashboard-redesign
  • Contexto de la aplicación: mobile-app, admin-panel, marketing
  • Propiedad del equipo: frontend-team, content-team
  • Estado del flujo de trabajo: approved, pending-review, priority-high

Los nombres de las etiquetas de archivo son opcionales en la mayoría de las operaciones de la API. Sin embargo, cada archivo de origen siempre tiene al menos una etiqueta. Al configurar un proyecto, se crea y asigna automáticamente una etiqueta de archivo predeterminada. Este comportamiento predeterminado mantiene los proyectos organizados incluso en configuraciones sencillas, permitiéndole al mismo tiempo crear estructuras de etiquetado más avanzadas cuando sea necesario.

Nombre de la etiqueta de archivo + Ruta del archivo

Cada archivo de origen se identifica de forma exclusiva mediante la combinación de su nombre de etiqueta de archivo y su ruta de archivo.

  • Si no proporciona una etiqueta de archivo personalizada al subir o procesar un archivo, se asignará automáticamente la etiqueta predeterminada.
  • El nombre de la etiqueta y la ruta de un archivo definen conjuntamente su identidad. Esta combinación garantiza que cada archivo sea único dentro de su proyecto, incluso si diferentes versiones o contextos comparten la misma ruta de archivo.

Parámetros de consulta

Al recuperar un archivo específico, los endpoints relacionados pueden aceptar parámetros de consulta como:

  • file_tag_name – La etiqueta asociada al archivo
  • file_path – La ruta al archivo

Estos parámetros le permiten localizar y recuperar con precisión los archivos correctos de su proyecto.


Listar todos los archivos de origen del proyecto

Enumera todos los archivos de origen de su proyecto, con opciones para filtrar, ordenar y paginar los resultados. Esto resulta útil cuando desea explorar sus archivos, comprobar su estado o encontrar archivos específicos basados en etiquetas, rutas o el método de subida.

Solicitud HTTP

GET https://app.ptc.wpml.org/api/v1/source_files

Parámetros

Parámetro Tipo Requerido Predeterminado Descripción
page integer No 1 El número de página para la paginación. Debe ser mayor que 0.
per_page integer No 50 El número de elementos por página. Debe ser mayor que 0.
order_by string No created_at El campo por el que ordenar. Valores permitidos: id, created_at, updated_at.
sort string No desc La dirección de la ordenación. Valores permitidos: asc, desc.
file_path string No Filtra por la ruta exacta de la ruta de archivo.
upload_origin string No Filtra por el modo en que se subió el archivo. Los valores permitidos incluyen: git, manual, api.

Respuestas

Respuesta correcta

200 OKapplication/json
{
  "source_files": [
    {
      "id": 123,
      "file_path": "locales/en.po",
      "translation_path": "locales/{{lang}}.po",
      "additional_translation_files": ["locales/{{lang}}.mo"],
      "status": "completed",
      "upload_origin": "git",
      "created_at": "2024-01-15T10:30:00.000Z",
      "updated_at": "2024-01-15T14:20:00.000Z",
      "file_tag": {
        "id": 456,
        "name": "frontend"
      },
      "download_url": "https://app.ptc.wpml.org/api/v1/source_files/download_translations?file_path=locales/en.po&file_tag_name=frontend"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 50,
    "total": 150,
    "total_pages": 3,
    "has_next_page": true,
    "has_previous_page": false
  }
}
Esquema de la respuesta

Objeto del archivo de origen:

Campo Tipo Descripción
id integer El identificador único del archivo de origen.
file_path string La ruta al archivo de origen dentro del proyecto.
translation_path string El patrón que define dónde deben guardarse los archivos traducidos.
additional_translation_files array[string] Las rutas para cualquier archivo de salida adicional.
status string El estado de procesamiento actual del archivo de origen.
upload_origin string Cómo se subió el archivo (git, manual, api).
created_at string Una marca de tiempo ISO 8601 que indica cuándo se creó originalmente el archivo de origen.
updated_at string Una marca de tiempo ISO 8601 que indica cuándo se actualizó el archivo de origen por última vez.
file_tag object Información sobre la etiqueta del archivo.
file_tag.id integer El identificador de la etiqueta del archivo.
file_tag.name string El nombre de la etiqueta del archivo.
download_url string La URL para descargar las traducciones de este archivo de origen.

Objeto de paginación:

Campo Tipo Descripción
page integer El número de página actual.
per_page integer El número de elementos por página.
total integer El número total de archivos de origen.
total_pages integer El número total de páginas.
has_next_page boolean Indica si hay una página siguiente disponible.
has_previous_page boolean Indica si hay una página anterior disponible.

Respuestas de error

No autorizado
401 Unauthorized
{
  "error": "Unauthorized access. Please provide a valid API token."
}
Prohibido
403 Forbidden
{
  "error": "Access denied. Insufficient permissions."
}
Parámetros no válidos
422 Unprocessable Entity
{
  "error": "Invalid parameters provided."
}

Ejemplos de solicitudes

Solicitud básica:

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Solicitud filtrada:

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files?file_tag_name=frontend&page=1&per_page=25&order_by=updated_at&sort=desc" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Ejemplos de código

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files?file_tag_name=frontend&page=1&per_page=25" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Obtener cadenas de traducción

Recupera todas las cadenas traducibles de un archivo de origen específico, junto con sus traducciones existentes en todos los idiomas de destino.

Este endpoint es útil para obtener contenido que necesita ser traducido o que ya ha sido traducido. El archivo de origen se identifica mediante file_path y file_tag_name.

Solicitud HTTP

GET https://app.ptc.wpml.org/api/v1/source_files/translation_strings

Parámetros

Parámetro Tipo Obligatorio Predeterminado Descripción
file_path string La ruta al archivo de origen dentro del proyecto.
file_tag_name string No El nombre de la etiqueta del archivo. Si no se proporciona, se utiliza la etiqueta predeterminada del proyecto.
page integer No 1 El número de página para la paginación (utilizado como cursor). Debe ser mayor que 0.
q string No La consulta de búsqueda para filtrar las cadenas de traducción por su texto de origen.

Respuestas

Respuesta correcta

200 OKapplication/json
{
  "total_strings_count": 1250,
  "translation_strings": [
    {
      "source": "Welcome to our application",
      "translations": {
        "es": "Bienvenido a nuestra aplicación",
        "fr": "Bienvenue dans notre application",
        "de": "Willkommen in unserer Anwendung"
      }
    },
    {
      "source": "Login",
      "translations": {
        "es": "Iniciar sesión",
        "fr": "Connexion",
        "de": "Anmelden"
      }
    }
  ],
  "cursor": 1
}
Esquema de respuesta
Campo Tipo Descripción
total_strings_count integer El número total de cadenas traducibles en el archivo de origen.
translation_strings array[object] El array de objetos de cadenas de traducción (paginado, máximo 500 por página).
translation_strings[].source string El texto de origen original que se va a traducir.
translation_strings[].translations object Un hash de traducciones donde las claves son códigos ISO de idioma y los valores son el texto traducido.
cursor integer El cursor de la página actual utilizado para la paginación.

Respuestas de error

Archivo de origen no encontrado
404 Not Found
{
  "error": "Source file not found"
}
No autorizado
401 Unauthorized
{
  "error": "Unauthorized access. Please provide a valid API token."
}
Prohibido
403 Forbidden
{
  "error": "Access denied. Insufficient permissions."
}
Parámetros no válidos
422 Unprocessable Entity
{
  "error": "Invalid parameters provided."
}

Ejemplos de solicitudes

Solicitud básica:

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files/translation_strings?file_path=locales/en.po" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Solicitud con etiqueta de archivo:

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files/translation_strings?file_path=locales/en.po&file_tag_name=frontend" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Solicitud con paginación y búsqueda:

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files/translation_strings?file_path=locales/en.po&file_tag_name=frontend&page=2&q=welcome" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Ejemplos de código

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files/translation_strings?file_path=locales/en.po&file_tag_name=frontend&page=1&q=login" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Crear el archivo de origen

Registra un nuevo archivo de origen en su proyecto para que esté listo para la traducción.

Este endpoint crea la entrada del archivo y establece su configuración de traducción, pero no adjunta el contenido real del archivo.

Después de crear el archivo, deberá utilizar el endpoint Procesar el archivo de origen para cargar el contenido e iniciar el proceso de traducción.

Solicitud HTTP

POST https://app.ptc.wpml.org/api/v1/source_files

Parámetros

Parámetro Tipo Requerido Descripción
file_path string La ruta donde debe almacenarse el archivo de origen en el proyecto. Debe tener una extensión compatible.
output_file_path string El patrón de ruta de salida para los archivos traducidos. Utilice {{lang}} como marcador de posición para el código de idioma.
translations array[object] No Los archivos de traducción preexistentes para cargar junto con el archivo de origen. Estos archivos se almacenarán tal como se proporcionen y sus cadenas no serán retraducidas por PTC. Tenga en cuenta que no se recomienda proporcionar traducciones existentes, ya que PTC produce mejores resultados cuando puede utilizar todo el contexto de su proyecto y traducir desde cero.
translations[].target_language_iso string El código ISO del idioma de destino para esta traducción. Puede encontrar la lista completa de idiomas compatibles y sus códigos ISO en el endpoint Listar todos los idiomas de destino.
translations[].file file El archivo de traducción que se va a cargar.
additional_translation_files array[object] No Configuraciones adicionales de archivos de salida para formatos específicos. Para ver qué formatos admiten archivos de salida adicionales, consulte el endpoint Listar formatos de archivo compatibles. Para los formatos no compatibles, este campo se ignorará.
additional_translation_files[].type string Consulte los formatos de archivo compatibles para obtener más detalles.
additional_translation_files[].path string El patrón de ruta para el archivo.

Respuestas

Respuesta correcta

201 Createdapplication/json
{
  "source_file": {
    "id": 123,
    "file_path": "src/locales/en.json",
    "created_at": "2024-01-15T10:30:00.000Z",
    "file_tag": {
      "id": 456,
      "name": "frontend"
    }
  }
}
Esquema de la respuesta
Campo Tipo Descripción
source_file.id integer El identificador único para el archivo de origen creado.
source_file.file_path string La ruta del archivo de origen dentro del proyecto.
source_file.created_at string Una marca de tiempo ISO 8601 que indica cuándo se creó originalmente el archivo de origen.
source_file.file_tag.id integer El identificador de la etiqueta del archivo.
source_file.file_tag.name string El nombre de la etiqueta del archivo.

Respuestas de error

Error de validación
422 Unprocessable Entity
{
  "success": false,
  "error": "Source file creation failed"
}
No autorizado
401 Unauthorized
{
  "error": "Unauthorized access. Please provide a valid API token."
}
Prohibido
403 Forbidden
{
  "error": "Access denied. Insufficient permissions."
}

Ejemplos de solicitudes

Creación básica de un archivo de origen:

curl -X POST "https://app.ptc.wpml.org/api/v1/source_files" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file_path=src/locales/en.json" \
  -F "output_file_path=src/locales/{lang}.json" \
  -F "file_tag_name=frontend"

Solicitud con URL de callback:

curl -X POST "https://app.ptc.wpml.org/api/v1/source_files" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file_path=src/locales/messages.po" \
  -F "output_file_path=locales/{lang}/messages.po" \
  -F "callback_url=https://your-app.com/webhooks/translation-complete"

Solicitud con traducciones preexistentes:

curl -X POST "https://app.ptc.wpml.org/api/v1/source_files" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file_path=src/messages.json" \
  -F "output_file_path=locales/{lang}/messages.json" \
  -F "translations[0][target_language_iso]=es" \
  -F "translations[0][file]=@spanish_translations.json" \
  -F "translations[1][target_language_iso]=fr" \
  -F "translations[1][file]=@french_translations.json"

Solicitud con archivos de salida adicionales:

curl -X POST "https://app.ptc.wpml.org/api/v1/source_files" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file_path=src/messages.po" \
  -F "output_file_path=locales/{lang}/messages.po" \
  -F "additional_translation_files[mo]=locales/{lang}/messages.mo" \
  -F "additional_translation_files[json]=locales/{lang}/messages.json"

Ejemplos de código

  • JavaScript (FormData)
  • Python (requests)
  • PHP (cURL)
  • Node.js (axios)
  • Cuerpo de la solicitud de callback
curl -X POST "https://app.ptc.wpml.org/api/v1/source_files" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file_path=src/locales/en.json" \
  -F "output_file_path=src/locales/{lang}.json"
{
  "source_file_id": 123,
  "status": "completed",
  "file_tag_name": "frontend",
  "download_url": "https://app.ptc.wpml.org/api/v1/source_files/download_translations?file_path=src/locales/en.json&file_tag_name=frontend",
  "file_path": "src/locales/en.json"
}

Procesar el archivo de origen

Sube contenido a un archivo de origen existente e inicia el proceso de traducción.

Este endpoint reemplaza el contenido actual del archivo, actualiza las cadenas traducibles almacenadas e inicia la traducción automática.

Para utilizar este endpoint, el archivo de origen ya debe existir en el proyecto. Si aún no lo ha creado, consulte Crear el archivo de origen.

Solicitud HTTP

PUT https://app.ptc.wpml.org/api/v1/source_files/process

Parámetros

Parámetro Tipo Requerido Descripción
file file El archivo de origen que se va a subir. El contenido del archivo se valida para garantizar que coincida con su extensión declarada. Por ejemplo, si la extensión del archivo es .json, el contenido subido debe ser un JSON válido.
file_path string La ruta al archivo de origen existente en el proyecto que debe actualizarse.
file_tag_name string No El nombre de la etiqueta de archivo asociada al archivo de origen. Si no se proporciona, se utiliza la etiqueta de archivo predeterminada del proyecto.
callback_url string No La URL que recibe notificaciones de webhook cuando finaliza el procesamiento del archivo.

Respuestas

Respuesta correcta

200 OKapplication/json
{
  "source_file": {
    "id": 123,
    "file_path": "src/locales/en.json",
    "created_at": "2024-01-15T10:30:00.000Z",
    "file_tag": {
      "id": 456,
      "name": "frontend"
    }
  }
}
Esquema de la respuesta
Campo Tipo Descripción
source_file.id integer El identificador único del archivo de origen procesado.
source_file.file_path string La ruta del archivo de origen dentro del proyecto.
source_file.created_at string Una marca de tiempo ISO 8601 que indica cuándo se creó originalmente el archivo de origen.
source_file.file_tag.id integer El identificador de la etiqueta de archivo.
source_file.file_tag.name string El nombre de la etiqueta de archivo.

Respuestas de error

Archivo de origen no encontrado
422 Unprocessable Entity
{
  "errors": {
    "file": ["File format is invalid or not supported"]
  }
}
No autorizado
401 Unauthorized
{
  "error": "Unauthorized access. Please provide a valid API token."
}
Prohibido
403 Forbidden
{
  "error": "Access denied. Insufficient permissions."
}

Flujo de trabajo

  1. Prerrequisito: El archivo de origen ya debe haber sido creado mediante Crear el archivo de origen.
  2. Subida de archivo: Se sube el nuevo contenido y se reemplaza el contenido del archivo existente.
  3. Procesamiento: Se extraen las nuevas cadenas traducibles y se traducen automáticamente.
  4. Callback: Se envía una notificación de webhook opcional cuando finaliza el procesamiento.

Callback de webhook

Cuando se proporciona una callback_url, PTC enviará una solicitud POST a esa URL al completar el procesamiento.

Cuerpo de la solicitud de callback:

{
  "source_file_id": 123,
  "status": "completed",
  "file_tag_name": "frontend",
  "download_url": "https://app.ptc.wpml.org/api/v1/source_files/download_translations?file_path=src/locales/en.json&file_tag_name=frontend",
  "file_path": "src/locales/en.json"
}

Ejemplos de solicitud

Procesamiento de archivo básico:

curl -X PUT "https://app.ptc.wpml.org/api/v1/source_files/process" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file=@updated_translations.json" \
  -F "file_path=src/locales/en.json" \
  -F "file_tag_name=frontend"

Solicitud con URL de callback:

curl -X PUT "https://app.ptc.wpml.org/api/v1/source_files/process" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file=@messages.po" \
  -F "file_path=locales/messages.po" \
  -F "callback_url=https://your-app.com/webhooks/translation-complete"

Ejemplos de código

curl -X PUT "https://app.ptc.wpml.org/api/v1/source_files/process" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file=@updated_translations.json" \
  -F "file_path=src/locales/en.json" \
  -F "file_tag_name=frontend" \
  -F "callback_url=https://your-app.com/webhooks/complete"

Formatos de archivo compatibles

El endpoint admite varios formatos de archivos traducibles, incluidos JSON, PO/POT, XLIFF y archivos Properties, entre otros. La validación del formato de archivo se realiza durante la subida para garantizar la compatibilidad.

Utilice el endpoint Listar formatos de archivo compatibles para obtener la lista completa de formatos admitidos.


Obtener el estado de la traducción

Recupera el progreso actual de la traducción para un archivo de origen específico, incluyendo cuánto se ha completado y su estado general de procesamiento.

Esto es útil para:

  • Seguimiento del progreso: monitorizar el avance de la traducción en trabajos de larga duración.
  • Actualizaciones de la interfaz de usuario: mostrar porcentajes de finalización en su aplicación.
  • Integración del flujo de trabajo: activar acciones cuando la traducción alcance un umbral definido.

Solicitud HTTP

GET https://app.ptc.wpml.org/api/v1/source_files/translation_status

Parámetros

Parámetro Tipo Obligatorio Descripción
file_path string La ruta al archivo de origen dentro del proyecto.
file_tag_name string No El nombre de la etiqueta del archivo. Si no se proporciona, se utiliza la etiqueta de archivo predeterminada del proyecto.

Respuestas

Respuesta correcta

200 OKapplication/json
{
  "translation_status": {
    "status": "completed",
    "completeness": 100
  }
}
Esquema de la respuesta
Campo Tipo Descripción
translation_status.status string El estado de procesamiento actual del archivo de origen. Consulte los valores de estado a continuación.
translation_status.completeness number El porcentaje de cadenas traducidas (0–100). Se calcula como (completed_translatable_strings / total_translatable_strings) × 100.

Valores de estado

El campo status puede contener los siguientes valores:

Estado Descripción
pending El archivo de origen está esperando a ser procesado.
processing La traducción está actualmente en curso.
completed Todas las traducciones se han completado.
failed El proceso de traducción ha encontrado errores.

Respuestas de error

Archivo de origen no encontrado
404 Not Found
{
  "error": "Source file not found"
}
No autorizado
401 Unauthorized
{
  "error": "Unauthorized access. Please provide a valid API token."
}
Prohibido
403 Forbidden
{
  "error": "Access denied. Insufficient permissions."
}
Parámetros no válidos
422 Unprocessable Entity
{
  "error": "Invalid parameters provided."
}

Ejemplos de solicitud

Solicitud básica:

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files/translation_status?file_path=locales/en.po" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Solicitud con etiqueta de archivo:

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files/translation_status?file_path=locales/en.po&file_tag_name=frontend" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Ejemplos de código

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files/translation_status?file_path=locales/en.po&file_tag_name=frontend" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Descargar todas las traducciones

Descarga todos los archivos traducidos de un archivo de origen específico en un archivo ZIP.

Este endpoint crea y devuelve un archivo comprimido que contiene todos los archivos de traducción en los idiomas de destino para el archivo de origen especificado.

Si no hay traducciones disponibles para el archivo, la solicitud devolverá un error 404 Not Found.

Solicitud HTTP

GET https://app.ptc.wpml.org/api/v1/source_files/download_translations

Parámetros

Parámetro Tipo Obligatorio Descripción
file_path string La ruta al archivo de origen dentro del proyecto.
file_tag_name string No La etiqueta del archivo. Si no se proporciona, se utiliza la etiqueta de archivo predeterminada del proyecto. Un archivo de origen se identifica de forma única mediante la combinación de file_path y file_tag_name.

Respuestas

Respuesta correcta

200 OKapplication/zip202 AcceptedRetry-After: 30
{
  "status": "processing",
  "message": "Translations are still in progress. Please retry after the specified delay.",
  "retry_after": 30
}

PTC procesa las traducciones de forma asíncrona. Normalmente hay una breve espera entre la carga de un archivo de origen y la disponibilidad de las traducciones para su descarga.

Cuando esto ocurra, espere el número de segundos especificado en Retry-After.

Respuestas de error

Archivo de origen no encontrado
404 Not Found
{
  "error": "Source file not found"
}
No hay traducciones disponibles
404 Not Found
{
  "error": "No translations are available for this source file"
}
No autorizado
401 Unauthorized
{
  "error": "Unauthorized access. Please provide a valid API token."
}
Prohibido
403 Forbidden
{
  "error": "Access denied. Insufficient permissions."
}
Parámetros no válidos
422 Unprocessable Entity
{
  "error": "Invalid parameters provided."
}

Ejemplos de solicitudes

Solicitud básica:

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files/download_translations?file_path=locales/en.po" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -o translations.zip

Solicitud con etiqueta de archivo:

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files/download_translations?file_path=locales/en.po&file_tag_name=frontend" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -o frontend-translations.zip

Ejemplos de código

curl -X GET "https://app.ptc.wpml.org/api/v1/source_files/download_translations?file_path=locales/en.po&file_tag_name=frontend" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -o translations.zip
# 200 -> saves the zip; 202 -> {"status":"processing","retry_after":N} (retry later);
# 404 -> {"error":"No translations are available for this source file"}

Carga masiva de archivos de origen

Sube un archivo ZIP que contiene varios archivos traducibles. Cada archivo del archivo comprimido se extrae, se valida y se procesa. Los formatos compatibles se identifican automáticamente.

Esta es la versión por lotes de Procesar el archivo de origen, diseñada para acelerar las actualizaciones a gran escala.

Información adicional

  • Si un archivo coincide con un archivo de origen existente, se actualiza con el nuevo contenido y las traducciones se activan de nuevo.
  • Si un archivo es compatible pero no coincide con ningún archivo de origen existente, se añade a la lista not_found_files y se ignora.
  • Los archivos con formatos no compatibles se enumeran en unsupported_files y se ignoran.
  • Los archivos con contenido no válido también se enumeran en unsupported_files y se ignoran.
  • Los archivos ZIP de gran tamaño pueden tardar más en procesarse. Los archivos se procesan uno por uno para gestionar los recursos, por lo que es recomendable dividir las cargas muy grandes (más de 100 archivos) en lotes más pequeños. Todos los archivos del archivo comprimido se configuran para traducirse automáticamente.
  • El archivo ZIP subido debe ser válido y legible. Todos los archivos de su interior deben tener un formato compatible. Los nombres de los archivos no deben incluir caracteres especiales que puedan causar problemas con las rutas.
  • Si se proporciona una callback_url, se envía una solicitud POST por cada archivo de origen procesado con sus resultados.

Solicitud HTTP

POST https://app.ptc.wpml.org/api/v1/source_files/bulk

Parámetros

Parámetro Tipo Requerido Descripción
zip_file archivo Un archivo ZIP que contiene los archivos de origen para subir. Debe ser un archivo ZIP válido.
file_tag_name cadena No El nombre de la etiqueta de archivo que se asociará a todos los archivos de origen del ZIP. Si no se especifica, se utiliza la etiqueta de archivo predeterminada del proyecto. Cada archivo de origen se identifica de forma única mediante la combinación de file_path y file_tag_name.
callback_url cadena No La URL que recibe las notificaciones de webhook cuando se procesa cada archivo.

Estructura esperada del archivo ZIP

El archivo ZIP puede contener archivos de origen en cualquier estructura de directorios. La estructura de directorios se conserva y los archivos se procesan de forma recursiva.

Ejemplo de estructura ZIP:

source-files.zip
├── locales/
│   ├── messages-en.po
│   ├── validation-en.po
│   └── admin-en.po
├── frontend/
│   ├── components-en.json
│   └── pages-en.json
│   └── not-found-en.json
├── app-strings-en.properties
└── readme.txt (will be ignored)

Tipos de archivo compatibles:

  • JSON: archivos .json
  • Gettext: archivos .po, .pot
  • Properties: archivos .properties
  • YAML: archivos .yml, .yaml
  • XML: archivos .xml
  • Strings: archivos .strings
  • XLIFF: archivos .xliff, .xlf
  • CSV: archivos .csv
  • PHP: archivos .php

Respuestas

Respuesta correcta

200 OKapplication/json
{
  "success": true,
  "file_tag": {
      "id": 456,
      "name": "backend"
  },
  "processed_files": [
    {
      "id": 123,
      "file_path": "locales/messages-en.po",
      "created_at": "2024-01-15T10:30:00.000Z",
      "file_tag": {
        "id": 456,
        "name": "backend"
      }
    },
    {
      "id": 124,
      "file_path": "locales/validation-en.po",
      "created_at": "2024-01-15T10:30:05.000Z",
      "file_tag": {
        "id": 456,
        "name": "backend"
      }
    }
  ],
  "unsupported_files": [
    "readme.txt",
    "config.ini"
  ],
  "not_found_files": ["frontend/not-found-en.json"]
}
Esquema de respuesta
Campo Tipo Descripción
success booleano Indica si la operación de carga masiva se ha realizado correctamente.
file_tag objeto La información de la etiqueta de archivo.
file_tag.id entero El identificador de la etiqueta de archivo.
file_tag.name cadena El nombre de la etiqueta de archivo.
processed_files array[objeto] Un array de archivos de origen que se han procesado correctamente.
processed_files[].id entero El identificador único del archivo de origen creado.
processed_files[].file_path cadena La ruta del archivo de origen, conservando la estructura original del ZIP.
processed_files[].created_at cadena Una marca de tiempo ISO 8601 que indica cuándo se creó el archivo de origen.
processed_files[].file_tag objeto La información de la etiqueta de archivo.
processed_files[].file_tag.id entero El identificador de la etiqueta de archivo.
processed_files[].file_tag.name cadena El nombre de la etiqueta de archivo.
unsupported_files array[cadena] Un array de nombres de archivo que no tienen un formato compatible.
not_found_files array[cadena] Un array de archivos compatibles que no coinciden con ningún archivo de origen existente y han sido ignorados.

Respuestas de error

Archivo ZIP no válido

422 Unprocessable Entity
{
  "success": false,
  "error": "File format is invalid",
  "processed_files": [],
  "unsupported_files": []
}

Error en el procesamiento

422 Unprocessable Entity
{
  "success": false,
  "error": "Failed to process ZIP archive",
  "processed_files": [],
  "unsupported_files": []
}

No autorizado

401 Unauthorized
{
  "error": "Unauthorized access. Please provide a valid API token."
}

Prohibido

403 Forbidden
{
  "error": "Access denied. Insufficient permissions."
}

Callback de webhook

Cuando se proporciona una callback_url, se envía una solicitud POST por cada archivo procesado.

Cuerpo de la solicitud de callback (por archivo):

{
  "source_file_id": 123,
  "status": "completed",
  "file_tag_name": "backend",
  "download_url": "https://app.ptc.wpml.org/api/v1/source_files/download_translations?file_path=locales/messages-en.po&file_tag_name=backend",
  "file_path": "locales/messages-en.po"
}

Ejemplos de solicitudes

Carga masiva básica:

curl -X POST "https://app.ptc.wpml.org/api/v1/source_files/bulk" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "zip_file=@source-files.zip" \
  -F "file_tag_name=backend"

Solicitud con URL de callback:

curl -X POST "https://app.ptc.wpml.org/api/v1/source_files/bulk" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "zip_file=@translations.zip" \
  -F "file_tag_name=localization" \
  -F "callback_url=https://your-app.com/webhooks/bulk-complete"

Ejemplos de código

curl -X POST "https://app.ptc.wpml.org/api/v1/source_files/bulk" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "zip_file=@source-files.zip" \
  -F "file_tag_name=backend" \
  -F "callback_url=https://your-app.com/webhooks/complete"
A continuación:

Consultar los formatos de archivo compatibles e idiomas de destino a través de la API →