API REST de Weblate¶

El API es accesible en la URL /api/ y está basada en el marco de trabajo Django REST. Puede utilizarlo directamente o por Cliente de Weblate.

El API además está documentado utilizando OpenAPI 3.1 en el URL /api/schema/, puede examinar en /api/docs/.

Nota

OpenAPI está disponible como una característica anticipada. La documentación es más probable incompleta en este punto y el asunto puede cambiar. Consulte la documentación antes para más información detallada en el API.

Autenticación y parámetros genéricos¶

La API de solo lectura está disponible sin autenticación a menos que se active la opción REQUIRE_LOGIN. Las solicitudes no autenticadas están sujetas a una limitación estricta (por defecto, 100 solicitudes al día), por lo que se recomienda usar autenticación.

La autenticación utiliza un toquen, el cual puede obtener en su perfil. Utilícelo en la cabecera Authorization:

ANY /¶

Comportamiento de solicitud genérica para el API, las cabeceras, códigos de estado y parámetros aquí aplican a todos los puntos finales también.

Parámetros de Solicitud:

format – Formato de respuesta (anula Accept). Los valores posibles dependen de la configuración del marco de trabajo REST. Por defecto, se admiten json, csv y api. Esta última proporciona una interfaz de navegador web para la API.
page – Devuelve la página dada de resultados del paginador (emplee los campos siguiente y anterior en la respuesta para automatizar la navegación).
page_size – Devuelve el número dado de elementos por solicitud. Por defecto es 50 y el máximo es de 1.000. Para las units de punto final lo predeterminado es 100 con un máximo de 10.000. El valor por defecto además está configurada utilizando los ajustes de PAGE_SIZE.

Cabeceras Solicitadas:

Accept – el tipo de contenido de la respuesta en la cabecera Accept
Authorization – toquen opcional para autenticar como Autorización: toquen TU-TOQUEN

Cabeceras de Respuesta:

Content-Type – esto depende de la cabecera Accept de la solicitud
Allow – Listado de métodos HTTP concedidos sobre objeto

Respuesta de Objeto JSON:

detail (string) – descripción detallada del resultado (para estado de HTTP en códigos distintos que 200 OK)
count (int) – conteo de elemento total para listados de objeto
next (string) – página siguiente de URL para listados de objeto
previous (string) – página anterior de URL para listados de objeto
results (array) – resultados para listados de objeto
url (string) – la URL para acceder a este recurso utilizando el API
web_url (string) – la URL para acceder a este recurso utilizando explorador web

Códigos del Status:

200 OK – cuando la solicitud fue manipulada correctamente
201 Created – cuando fue creado un objeto nuevo correctamente
204 No Content – cuando fue borrado un objeto correctamente
400 Bad Request – cunado forma parámetros que falten
403 Forbidden – cuando el acceso es denegado
429 Too Many Requests – cuando la limitación está en su lugar

Tóquenes de autenticación¶

Distinto en la versión 4.10: Los tóquenes con alcance de proyecto se introdujeron en la versión 4.10.

Cada usuario tiene un toquen de acceso personal el cual puede ser obtenido en el perfil del usuario. Los tóquenes del usuario generado nuevamente tiene el prefijo wlu_.

Es posible crear tóquenes de alcance del proyecto para acceso API para solo el proyecto dado. Estos tóquenes pueden ser identificados por el prefijo wlp_.

Ver también

Ejemplos de autenticación¶

Solicitud de ejemplo:

GET /api/ HTTP/1.1
Host: example.com
Accept: application/json, text/javascript
Authorization: Token YOUR-TOKEN

Respuesta de ejemplo:

HTTP/1.0 200 OK
Date: Fri, 25 Mar 2016 09:46:12 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, HEAD, OPTIONS

{
    "projects":"http://example.com/api/projects/",
    "components":"http://example.com/api/components/",
    "translations":"http://example.com/api/translations/",
    "languages":"http://example.com/api/languages/"
}

Ejemplo CURL:

curl \
    -H "Authorization: Token TOKEN" \
    https://example.com/api/

Aprobar Ejemplos de Parámetros¶

Para el método POST, los parámetros se pueden especificar como envío de formulario (application/x-www-form-urlencoded) o como JSON (application/json).

Ejemplo de formulario de solicitud:

POST /api/projects/hello/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
Authorization: Token TOKEN

operation=pull

Ejemplo de solicitud de JSON:

POST /api/projects/hello/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"operation":"pull"}

Ejemplo CURL:

curl \
    -d operation=pull \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/components/hello/weblate/repository/

Ejemplo de CURL JSON:

curl \
    --data-binary '{"operation":"pull"}' \
    -H "Content-Type: application/json" \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/components/hello/weblate/repository/

Componentes y categorías¶

Para acceder a un componente anidado dentro de una Categoría, debe codificar la URL del nombre de la categoría en un nombre de componente separado por una barra diagonal. Por ejemplo, usage ubicado en la categoría docs debe usarse como docs%252Fusage. La URL completa en este caso sería, por ejemplo, https://example.com/api/components/hello/docs%252Fusage/repository/.

Limitación del tipo de API¶

Las solicitudes de API tienen una tasa limitada; la configuración predeterminada los limites a 100 solicitudes por día para usuarios anónimos y 5.000 solicitudes por hora para usuarios autenticados.

El tipo de límite puede ser ajustado en el archivo settings.py; consulte Throttling in Django REST framework documentation para más detalles sobre como configurarlo.

En el contenedor de Docker, esto se puede configurar usando WEBLATE_API_RATELIMIT_ANON y WEBLATE_API_RATELIMIT_USER.

El estado del tipo limitado está reportado en las siguientes cabeceras:

`X-RateLimit-Limit`	Número permitido de solicitudes a realizar
`X-RateLimit-Remaining`	Número restante de solicitudes por realizar
`X-RateLimit-Reset`	Número de segundos hasta que se reinicia la ventana de límite de velocidad

Distinto en la versión 4.1: Se agregaron encabezados de estado de limitación de velocidad.

Ver también

Respuestas de error¶

Distinto en la versión 5.10: Respuestas erróneas eran punto final específico antes de este lanzamiento.

Error de respuesta de Weblate son formateadas basadas en Error Response Format.

Punto de Apunte de API¶

GET /api/¶

El punto de apunte raíz de la API.

Solicitud de ejemplo:

GET /api/ HTTP/1.1
Host: example.com
Accept: application/json, text/javascript
Authorization: Token YOUR-TOKEN

Respuesta de ejemplo:

HTTP/1.0 200 OK
Date: Fri, 25 Mar 2016 09:46:12 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, HEAD, OPTIONS

{
    "projects":"http://example.com/api/projects/",
    "components":"http://example.com/api/components/",
    "translations":"http://example.com/api/translations/",
    "languages":"http://example.com/api/languages/"
}

Usuarios¶

Added in version 4.0.

GET /api/users/¶

Devuelve un listado de usuarios si tiene permisos para ver y gestionar usuarios. En caso contrario, podrá ver solo sus propios datos.

Parámetros de Solicitud:

username (string) – Usuario a buscar
id (int) – ID de usuario para buscar

Ver también

Los atributos de objeto de usuarios están documentados en GET /api/users/(str:username)/.

POST /api/users/¶

Crea un usuario nuevo.

Parámetros:

username (string) – Apodo
full_name (string) – Nombre completo del usuario
email (string) – Correo-e del usuario
is_superuser (boolean) – ¿El usuario es superusuario? (opcional)
is_active (boolean) – ¿El usuario está activo? (opcional)
is_bot (boolean) – ¿Es el usuario un bot? (opcional) (utilizado para tóquenes de ámbito del proyecto)

GET /api/users/(str: username)/¶

Devuelve información sobre usuarios.

Parámetros:

username (string) – Alias del Usuario

Respuesta de Objeto JSON:

username (string) – alias de un usuario
full_name (string) – nombre completo de un usuario
email (string) – correo-e de un usuario
is_superuser (boolean) – si el usuario es un súper usuario
is_active (boolean) – si el usuario está activo
is_bot (boolean) – si el usuario es bot (utilizado para tóquenes de ámbito de proyecto)
date_joined (string) – fecha que el usuario fue creado
last_login (string) – fecha del último acceso del usuario
groups (array) – enlace a grupo asociado; consulte GET /api/groups/(int:id)/
languages (array) – enlace para idiomas traducidos; consulte GET /api/languages/(string:language)/

Ejemplo de datos JSON:

{
    "email": "user@example.com",
    "full_name": "Example User",
    "username": "exampleusername",
    "groups": [
        "http://example.com/api/groups/2/",
        "http://example.com/api/groups/3/"
    ],
    "languages": [
        "http://example.com/api/languages/cs/",
    ],
    "is_superuser": true,
    "is_active": true,
    "is_bot": false,
    "date_joined": "2020-03-29T18:42:42.617681Z",
    "url": "http://example.com/api/users/exampleusername/",
    "contributions_url": "http://example.com/api/users/exampleusername/contributions/"
    "statistics_url": "http://example.com/api/users/exampleusername/statistics/"
}

PUT /api/users/(str: username)/¶

Cambia parámetros del usuario.

Parámetros:

username (string) – Alias del Usuario

Respuesta de Objeto JSON:

username (string) – alias de un usuario
full_name (string) – nombre completo de un usuario
email (string) – correo-e de un usuario
is_superuser (boolean) – si el usuario es un súper usuario
is_active (boolean) – si el usuario está activo
is_bot (boolean) – si el usuario es bot (utilizado para tóquenes de ámbito de proyecto)
date_joined (string) – fecha que el usuario fue creado

PATCH /api/users/(str: username)/¶

Cambia parámetros del usuario.

Parámetros:

username (string) – Alias del Usuario

Respuesta de Objeto JSON:

username (string) – alias de un usuario
full_name (string) – nombre completo de un usuario
email (string) – correo-e de un usuario
is_superuser (boolean) – si el usuario es un súper usuario
is_active (boolean) – si el usuario está activo
is_bot (boolean) – si el usuario es bot (utilizado para tóquenes de ámbito de proyecto)
date_joined (string) – fecha que el usuario fue creado

DELETE /api/users/(str: username)/¶

Elimina toda la información de la cuenta de usuario y la marca como inactiva.

Parámetros:

username (string) – Alias del Usuario

POST /api/users/(str: username)/groups/¶

Asocia grupos con un usuario.

Parámetros:

username (string) – Alias del Usuario

Parámetros del Formulario:

string group_id – El único ID del grupo

DELETE /api/users/(str: username)/groups/¶

Added in version 4.13.1.

Eliminar un usuario de un grupo.

Parámetros:

username (string) – Alias del Usuario

Parámetros del Formulario:

string group_id – El único ID del grupo

GET /api/users/(str: username)/statistics/¶

Enumera estadísticas de una cuenta de usuario.

Parámetros:

username (string) – Alias del Usuario

Respuesta de Objeto JSON:

translated (int) – Número de traducciones por usuario
suggested (int) – Número de sugerencias por usuario
uploaded (int) – Número de subidas por usuario
commented (int) – Número de comentarios por usuario
languages (int) – Número de idiomas en que puede traducir el usuario

GET /api/users/(str: username)/contributions/¶

Listado de traducciones con contribuciones desde un usuario.

Parámetros:

username (string) – Alias del Usuario

Respuesta de Objeto JSON:

translations (array) – enlace a traducciones; consulte GET /api/translations/(string:project)/(string:component)/(string:language)/

GET /api/users/(str: username)/notifications/¶

Listado de suscripciones de un usuario.

Parámetros:

username (string) – Alias del Usuario

POST /api/users/(str: username)/notifications/¶

Asociar suscripciones con un usuario.

Parámetros:

username (string) – Alias del Usuario

Solicitud de Objeto JSON:

notification (string) – Nombre de notificación registrada
scope (int) – Ámbito de notificación desde las elecciones disponibles
frequency (int) – Elecciones de frecuencia para notificaciones

GET /api/users/(str: username)/notifications/(int: subscription_id)/¶

Obtiene una suscripción asociada con un usuario.

Parámetros:

username (string) – Alias del Usuario
subscription_id (int) – ID de notificación registrada

PUT /api/users/(str: username)/notifications/(int: subscription_id)/¶

Edita una suscripción asociada con un usuario.

Parámetros:

username (string) – Alias del Usuario
subscription_id (int) – ID de notificación registrada

Solicitud de Objeto JSON:

notification (string) – Nombre de notificación registrada
scope (int) – Ámbito de notificación desde las elecciones disponibles
frequency (int) – Elecciones de frecuencia para notificaciones

PATCH /api/users/(str: username)/notifications/(int: subscription_id)/¶

Edita una suscripción asociada con un usuario.

Parámetros:

username (string) – Alias del Usuario
subscription_id (int) – ID de notificación registrada

Solicitud de Objeto JSON:

notification (string) – Nombre de notificación registrada
scope (int) – Ámbito de notificación desde las elecciones disponibles
frequency (int) – Elecciones de frecuencia para notificaciones

DELETE /api/users/(str: username)/notifications/(int: subscription_id)/¶

Elimina una suscripción asociada con un usuario.

Parámetros:

username (string) – Alias del Usuario
subscription_id – Nombre de notificación registrada
subscription_id – int

Grupos¶

Added in version 4.0.

GET /api/groups/¶: Devuelve una lista de grupos si tiene permisos para ver y gestionar grupos. En caso contrario, verá solo los grupos a los que pertenece el usuario.

Ver también

Atributos de objeto del grupo están documentados en GET /api/groups/(int:id)/.

POST /api/groups/¶

Crea un grupo nuevo.

Parámetros:

name (string) – Nombre de grupo
project_selection (int) – Grupo de selección del proyecto desde opciones proporcionadas
language_selection (int) – Grupo de idioma seleccionado desde opciones proporcionadas
defining_project (str) – enlace al proyecto de la definición, utilizado para Gestionar el control de acceso por proyecto; consulte GET /api/projects/(string:project)/

GET /api/groups/(int: id)/¶

Devuelve información relativa al grupo.

Parámetros:

id (int) – ID del grupo

Respuesta de Objeto JSON:

name (string) – nombre de un grupo
project_selection (int) – entero que se corresponde a un grupo de proyectos
language_selection (int) – entero que se corresponde a un grupo de idiomas
roles (array) – enlaza a roles asociados; consulte GET /api/roles/(int:id)/
projects (array) – enlaza a proyectos asociados; consulte GET /api/projects/(string:project)/
components (array) – enlaza a componentes asociados; consulte GET /api/components/(string:project)/(string:component)/
componentlists (array) – enlaza a componentlist asociado; consulte GET /api/component-lists/(str:slug)/
defining_project (str) – enlace al proyecto de la definición, utilizado para Gestionar el control de acceso por proyecto; consulte GET /api/projects/(string:project)/
admins (array) – enlace a administradores asociados; consulte GET /api/users/(str:username)/

Ejemplo de datos JSON:

{
    "name": "Guests",
    "defining_project": null,
    "project_selection": 3,
    "language_selection": 1,
    "url": "http://example.com/api/groups/1/",
    "roles": [
        "http://example.com/api/roles/1/",
        "http://example.com/api/roles/2/"
    ],
    "languages": [
        "http://example.com/api/languages/en/",
        "http://example.com/api/languages/cs/",
    ],
    "projects": [
        "http://example.com/api/projects/demo1/",
        "http://example.com/api/projects/demo/"
    ],
    "componentlist": "http://example.com/api/component-lists/new/",
    "components": [
        "http://example.com/api/components/demo/weblate/"
    ],
    "admins": [
        "http://example.com/api/users/exampleusername/"
    ]
}

PUT /api/groups/(int: id)/¶

Cambia los parámetros del grupo.

Parámetros:

id (int) – ID del grupo

Respuesta de Objeto JSON:

name (string) – nombre de un grupo
project_selection (int) – entero que se corresponde a un grupo de proyectos
language_selection (int) – entero que se corresponde a un grupo de idiomas

PATCH /api/groups/(int: id)/¶

Cambia los parámetros del grupo.

Parámetros:

id (int) – ID del grupo

Respuesta de Objeto JSON:

name (string) – nombre de un grupo
project_selection (int) – entero que se corresponde a un grupo de proyectos
language_selection (int) – entero que se corresponde a un grupo de idiomas

DELETE /api/groups/(int: id)/¶

Elimina el grupo.

Parámetros:

id (int) – ID del grupo

POST /api/groups/(int: id)/roles/¶

Asocia roles con un grupo.

Parámetros:

id (int) – ID del grupo

Parámetros del Formulario:

string role_id – El único ID de rol

DELETE /api/groups/(int: id)/roles/(int: role_id)¶

Borrar rol desde un grupo.

Parámetros:

id (int) – ID del grupo
role_id (int) – El único ID de rol

POST /api/groups/(int: id)/components/¶

Asocia componentes con un grupo.

Parámetros:

id (int) – ID del grupo

Parámetros del Formulario:

string component_id – El único ID del componente

DELETE /api/groups/(int: id)/components/(int: component_id)¶

Borra componente desde un grupo.

Parámetros:

id (int) – ID del grupo
component_id (int) – El único ID del componente

POST /api/groups/(int: id)/projects/¶

Asocia proyectos con un grupo.

Parámetros:

id (int) – ID del grupo

Parámetros del Formulario:

string project_id – El único ID de proyecto

DELETE /api/groups/(int: id)/projects/(int: project_id)¶

Borra proyecto desde un grupo.

Parámetros:

id (int) – ID del grupo
project_id (int) – El único ID de proyecto

POST /api/groups/(int: id)/languages/¶

Asocia idioma con un grupo.

Parámetros:

id (int) – ID del grupo

Parámetros del Formulario:

string language_code – El único código de idioma

DELETE /api/groups/(int: id)/languages/(string: language_code)¶

Borra idioma desde un grupo.

Parámetros:

id (int) – ID del grupo
language_code (string) – El único código de idioma

POST /api/groups/(int: id)/componentlists/¶

Asocia componentlists con un grupo.

Parámetros:

id (int) – ID del grupo

Parámetros del Formulario:

string component_list_id – El único ID de componentlist

DELETE /api/groups/(int: id)/componentlists/(int: component_list_id)¶

Borra componentlist desde un grupo.

Parámetros:

id (int) – ID del grupo
component_list_id (int) – El único ID de componentlist

POST /api/groups/(int: id)/admins/¶

Added in version 5.5.

Añade usuario al equipo admins.

Parámetros:

id (int) – ID del grupo

Parámetros del Formulario:

string user_id – El ID del usuario

DELETE /api/groups/(int: id)/admins/(int: user_id)¶

Added in version 5.5.

Elimina usuario de los administradores del equipo.

Parámetros:

id (int) – ID del grupo
user_id (integer) – El ID del usuario

Roles¶

GET /api/roles/¶: Devuelve un listado de todos los roles asociados con usuario. Si el usuario es súper usuario, entonces es devuelto el listado de todos los roles existentes.

Ver también

Atributos del objeto de roles están documentados en GET /api/roles/(int:id)/.

POST /api/roles/¶

Crea un rol nuevo.

Parámetros:

name (string) – Nombre del rol
permissions (array) – Listado de codenames de permisos

GET /api/roles/(int: id)/¶

Devuelve información relativa al rol.

Parámetros:

id (int) – ID del rol

Respuesta de Objeto JSON:

name (string) – Nombre del rol
permissions (array) – lista de codenames de permisos

Ejemplo de datos JSON:

{
    "name": "Access repository",
    "permissions": [
        "vcs.access",
        "vcs.view"
    ],
    "url": "http://example.com/api/roles/1/",
}

PUT /api/roles/(int: id)/¶

Cambia los parámetros del rol.

Parámetros:

id (int) – ID del rol

Respuesta de Objeto JSON:

name (string) – Nombre del rol
permissions (array) – lista de codenames de permisos

PATCH /api/roles/(int: id)/¶

Cambia los parámetros del rol.

Parámetros:

id (int) – ID del rol

Respuesta de Objeto JSON:

name (string) – Nombre del rol
permissions (array) – lista de codenames de permisos

DELETE /api/roles/(int: id)/¶

Elimina el rol.

Parámetros:

id (int) – ID del rol

Idiomas¶

GET /api/languages/¶: Devuelve un listado de todos los idiomas.

Ver también

Los atributos de objeto de idioma se documentan en GET /api/languages/(string:language)/.

POST /api/languages/¶

Crea un idioma nuevo.

Parámetros:

code (string) – Nombre del idioma
name (string) – Nombre del idioma
direction (string) – Dirección del texto
population (int) – Número de hablantes
plural (object) – Fórmula y número de plurales del idioma

GET /api/languages/(string: language)/¶

Devuelve información relativa al idioma.

Parámetros:

language (string) – Código de idioma

Respuesta de Objeto JSON:

code (string) – Código de idioma
direction (string) – Dirección del texto
plural (object) – Objeto de información de plurales de un idioma
aliases (array) – Formación de alias para idioma

Solicitud de Objeto JSON:

population (int) – Número de hablantes

Ejemplo de datos JSON:

{
    "code": "en",
    "direction": "ltr",
    "name": "English",
    "population": 159034349015,
    "plural": {
        "id": 75,
        "source": 0,
        "number": 2,
        "formula": "n != 1",
        "type": 1
    },
    "aliases": [
        "english",
        "en_en",
        "base",
        "source",
        "eng"
    ],
    "url": "http://example.com/api/languages/en/",
    "web_url": "http://example.com/languages/en/",
    "statistics_url": "http://example.com/api/languages/en/statistics/"
}

PUT /api/languages/(string: language)/¶

Permite cambiar los parámetros del idioma.

Parámetros:

language (string) – Código del idioma

Solicitud de Objeto JSON:

name (string) – Nombre del idioma
direction (string) – Dirección del texto
population (int) – Número de hablantes
plural (object) – Detalles del plural del idioma

PATCH /api/languages/(string: language)/¶

Permite cambiar los parámetros del idioma.

Parámetros:

language (string) – Código del idioma

Solicitud de Objeto JSON:

name (string) – Nombre del idioma
direction (string) – Dirección del texto
population (int) – Número de hablantes
plural (object) – Detalles del plural del idioma

DELETE /api/languages/(string: language)/¶

Elimina el idioma.

Parámetros:

language (string) – Código del idioma

GET /api/languages/(string: language)/statistics/¶

Devuelve estadísticas sobre un idioma.

Parámetros:

language (string) – Código de idioma

Ver también

Los atributos devueltos están descritos en Estadísticas.

Proyectos¶

GET /api/projects/¶: Devuelve un listado de todos los proyectos.

Ver también

Los atributos de objeto de proyecto se documentan en GET /api/projects/(string:project)/.

POST /api/projects/¶

Crea un proyecto nuevo.

Parámetros:

name (string) – Nombre del proyecto
slug (string) – Indicación del proyecto
web (string) – Sitio web del proyecto

GET /api/projects/(string: project)/¶

Devuelve información relativa al proyecto.

Parámetros:

project (string) – Indicador de URL del proyecto

Respuesta de Objeto JSON:

name (string) – nombre del proyecto
slug (string) – indicador del proyecto
web (string) – sitio web del proyecto
components_list_url (string) – URL a la lista de componentes; consulte GET /api/projects/(string:project)/components/
repository_url (string) – URL al estado del repositorio; consulte GET /api/projects/(string:project)/repository/
changes_list_url (string) – URL a la lista de cambios; consulte GET /api/projects/(string:project)/changes/
credits_url (string) – URL al listado de reconocimientos del contribuidor; consulte GET /api/projects/(string:project)/credits/
translation_review (boolean) – Activar revisiones
source_review (boolean) – Activar revisiones de origen
set_language_team (boolean) – Definir cabecera «Language-Team»
enable_hooks (boolean) – Activar actuadores
instructions (string) – Instrucciones de traducción
language_aliases (string) – Alias de idiomas

Ejemplo de datos JSON:

{
    "name": "Hello",
    "slug": "hello",
    "url": "http://example.com/api/projects/hello/",
    "web": "https://weblate.org/",
    "web_url": "http://example.com/projects/hello/"
}

PATCH /api/projects/(string: project)/¶

Added in version 4.3.

Edita un proyecto por una solicitud de PATCH.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL

PUT /api/projects/(string: project)/¶

Added in version 4.3.

Edita un proyecto por una solicitud PUT.

Parámetros:

project (string) – Indicador de URL del proyecto

DELETE /api/projects/(string: project)/¶

Elimina un proyecto.

Parámetros:

project (string) – Indicador de URL del proyecto

GET /api/projects/(string: project)/changes/¶

Devuelve un listado de cambios de proyecto. Esto esencialmente es un proyecto al alcance GET /api/changes/ aceptando los mismos parámetros.

Parámetros:

project (string) – Indicador de URL del proyecto

Respuesta de Objeto JSON:

results (array) – formación de objetos del componente; consulte GET /api/changes/(int:id)/

GET /api/projects/(string: project)/file/¶

Added in version 5.5.

Descarga todas las traducciones disponibles asociadas con el proyecto como un archivo archivador utilizando el formato e idioma solicitado.

Parámetros:

project (string) – Indicador de URL del proyecto

Parámetros de Solicitud:

format (string) – El formato de archivador para utilizar; si no está especificado, por defecto a zip; Formatos admitidos: zip y zip:CONVERSION donde CONVERSION es uno de listados convertidos en Descargar traducciones.
language_code (string) – El código del idioma para descargar; si no está especificado, todos los idiomas serán incluidos.

GET /api/projects/(string: project)/repository/¶

Devuelve información sobre el estado del repositorio VCS. Este punto final solo contiene un sumario de todo el conjunto para todos los repositorios del proyecto. Para obtener más estado detallado utilice GET /api/components/(string:project)/(string:component)/repository/.

Parámetros:

project (string) – Indicador de URL del proyecto

Respuesta de Objeto JSON:

needs_commit (boolean) – si hay algún cambio pendiente para consolidar
needs_merge (boolean) – si hay cualquier cambio de desarrollo para fusionar
needs_push (boolean) – si hay algún cambio local para subir

Ejemplo de datos JSON:

{
    "needs_commit": true,
    "needs_merge": false,
    "needs_push": true
}

POST /api/projects/(string: project)/repository/¶

Efectúa la operación indicada en el repositorio del sistema de control de versiones.

Parámetros:

project (string) – Indicador de URL del proyecto

Solicitud de Objeto JSON:

operation (string) – Operación para realizar: uno de push, pull, commit, reset, cleanup, file-sync, file-scan

Respuesta de Objeto JSON:

result (boolean) – resultado de la operación

Ejemplo CURL:

curl \
    -d operation=pull \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/projects/hello/repository/

Ejemplo de solicitud de JSON:

POST /api/projects/hello/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"operation":"pull"}

Ejemplo de respuesta en JSON

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{"result":true}

GET /api/projects/(string: project)/components/¶

Devuelve un listado de componentes de traducción en el proyecto indicado.

Parámetros:

project (string) – Indicador de URL del proyecto

Respuesta de Objeto JSON:

results (array) – formación de objetos componentes; consulte GET /api/components/(string:project)/(string:component)/

POST /api/projects/(string: project)/components/¶

Distinto en la versión 4.3: Los parámetros zipme y docfile ahora están aceptados para componentes menores de VCS, consulte Archivos locales.

Distinto en la versión 4.6: Los repositorios clonados ahora son compartidos automáticamente internos un proyectos utilizando URL internos de Weblate. Emplee disable_autoshare para apagar esto.

Crea componentes de traducción en el proyecto indicado.

Consejo

Utilice URL internos de Weblate cuando cree múltiples componentes desde un único repositorio VCS.

Nota

Muchos de la creación del componente sucede en el segundo plano. Compruebe el atributo task_url de componente creado y siga el progreso allí.

Parámetros:

project (string) – Indicador de URL del proyecto

Parámetros del Formulario:

file zipfile – Archivo ZIP para subir en Weblate para inicialización de traducciones
file docfile – Documento para traducir
boolean disable_autoshare – Inhabilita repositorios automáticos compartidos por medio de URL internos de Weblate.

Solicitud de Objeto JSON:

object – Parámetros de componente, consulte GET /api/components/(string:project)/(string:component)/

Respuesta de Objeto JSON:

result (object) – Objeto de componente creado; consulte GET /api/components/(string:project)/(string:component)/

JSON no puede ser utilizado cuando suba los archivos utilizando los parámetros zipfile y docfile. Los datos tiene que ser subidos como multipart/form-data.

Ejemplo de la solicitud del formulario CURL:

curl \
    --form docfile=@strings.html \
    --form name=Weblate \
    --form slug=weblate \
    --form file_format=html \
    --form new_lang=add \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/projects/hello/components/

Ejemplo de solicitud CURL JSON:

curl \
    --data-binary '{
        "branch": "main",
        "file_format": "po",
        "file_format_params": {
            "po_line_wrap": 65535,
            "po_no_location": true
        },
        "filemask": "po/*.po",
        "name": "Weblate",
        "slug": "weblate",
        "repo": "https://github.com/WeblateOrg/hello.git",
        "template": "",
        "new_base": "po/hello.pot",
        "vcs": "git"
    }' \
    -H "Content-Type: application/json" \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/projects/hello/components/

JSON solicita crear un componente nuevo desde Git:

POST /api/projects/hello/components/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{
    "branch": "main",
    "file_format": "po",
    "file_format_params": {
        "po_line_wrap": 65535,
        "po_no_location": true
    },
    "filemask": "po/*.po",
    "name": "Weblate",
    "slug": "weblate",
    "repo": "https://github.com/WeblateOrg/hello.git",
    "template": "",
    "new_base": "po/hello.pot",
    "vcs": "git"
}

JSON solicita crear un componente nuevo desde otro:

POST /api/projects/hello/components/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{
    "file_format": "po",
    "filemask": "po/*.po",
    "name": "Weblate",
    "slug": "weblate",
    "repo": "weblate://weblate/hello",
    "template": "",
    "new_base": "po/hello.pot",
    "vcs": "git"
}

Ejemplo de respuesta en JSON

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{
    "branch": "main",
    "file_format": "po",
    "file_format_params": {
        "po_line_wrap": 65535,
        "po_no_location": true
    },
    "filemask": "po/*.po",
    "git_export": "",
    "license": "",
    "license_url": "",
    "name": "Weblate",
    "slug": "weblate",
    "project": {
        "name": "Hello",
        "slug": "hello",
        "source_language": {
            "code": "en",
            "direction": "ltr",
             "population": 159034349015,
            "name": "English",
            "url": "http://example.com/api/languages/en/",
            "web_url": "http://example.com/languages/en/"
        },
        "url": "http://example.com/api/projects/hello/",
        "web": "https://weblate.org/",
        "web_url": "http://example.com/projects/hello/"
    },
    "repo": "file:///home/nijel/work/weblate-hello",
    "template": "",
    "new_base": "",
    "url": "http://example.com/api/components/hello/weblate/",
    "vcs": "git",
    "web_url": "http://example.com/projects/hello/weblate/"
}

GET /api/projects/(string: project)/languages/¶

Devuelve estadísticas paginadas para todos los idiomas dentro de un proyecto.

Parámetros:

project (string) – Indicador de URL del proyecto

Respuesta de Objeto JSON:

results (array) – formación de estadísticas de traducción de objetos
language (string) – nombre del idioma
code (string) – código del idioma
total (int) – número total de cadenas
translated (int) – número de cadenas traducidas
translated_percent (float) – porcentaje de cadenas traducidas
total_words (int) – número total de palabras
translated_words (int) – número de palabras traducidas
words_percent (float) – porcentaje de palabras traducidas

GET /api/projects/(string: project)/statistics/¶

Devuelve estadísticas sobre un proyecto.

Parámetros:

project (string) – Indicador de URL del proyecto

Ver también

Los atributos devueltos están descritos en Estadísticas.

GET /api/projects/(string: project)/categories/¶

Added in version 5.0: Devuelve categorías para un proyecto. Consulte GET /api/categories/(int:id)/ para definiciones de campo.

parámetro de proyecto:: Indicador de URL del proyecto
tipo de proyecto:: cadena

GET /api/projects/(string: project)/labels/¶

Added in version 5.3: Devuelve etiquetas para un proyecto.

parámetro de proyecto:: Indicador de URL del proyecto
tipo de proyecto:: cadena
>json int id:: Id. de la etiqueta
>json string name:: nombre de etiqueta
>json string color:: color de la etiqueta

POST /api/projects/(string: project)/labels/¶

Added in version 5.3: Crea una etiqueta para un proyecto.

parámetro de proyecto:: Indicador de URL del proyecto
tipo de proyecto:: cadena
<json string name:: nombre de etiqueta
<json string color:: color de la etiqueta

DELETE /api/projects/(string: project)/labels/(int: label_id)/¶

Added in version 5.14: Borra una etiqueta desde un proyecto.

parámetro de proyecto:: Indicador de URL del proyecto
tipo de proyecto:: cadena
parámetro label_id:: Id. de la etiqueta a borrar
teclee label_id:: integer

GET /api/projects/(string: project)/credits/¶

Devuelve reconocimientos de contribuidor para un proyecto.

Added in version 5.7.

Parámetros:

project (string) – Indicador de URL del proyecto
start (date) – Marca de tiempo ISO 8601 (obligatoria)
end (date) – Sello de tiempo ISO 8601 (obligatorio)
lang (source_language) – Código de idioma para búsqueda

Respuesta de Objeto JSON:

email (string) – Correo-e del contribuidor
full_name (string) – Nombre completo del contribuidor
change_count (string) – Número de cambios realizados en el intervalo de tiempo

GET /api/projects/{string:project}/machinery_settings/¶

Added in version 5.9.

Devuelve ajustes de sugerencia automática para un proyecto, consistiendo en configuraciones definidas por cada servicio de traducción instalado.

Parámetros:

project (string) – Indicador de URL del proyecto

Respuesta de Objeto JSON:

suggestion_settings (object) – Configuración para todos los servicios instalados.

POST /api/projects/{string:project}/machinery_settings/¶

Added in version 5.9.

Crea o actualiza la configuración del servicio para un proyecto.

Parámetros:

project (string) – Indicador de URL del proyecto

Parámetros del Formulario:

string service – Nombre del servicio
string configuration – Configuración del servicio en JSON

GET /api/projects/(string: project)/languages/(string: language_code)/file/¶

Distinto en la versión 5.15.1: Habilidad añadida para descargar archivo ZIP de todos los componentes de traducciones en un proyecto para 1 idioma específico.

Descarga un archivo ZIP de todos los archivos de traducción para un language_code específico a través de todos los componentes para un project dado en vez de descargar archivos individuales traducidos y empaquetarlos y comprimirlos manualmente, con el archivador llamado {project-slug}-{language-code}.zip y organizado por rutas de componente (p.e., component-slug/po/lang.po).

Parámetros:

project (string) – Indicador de URL del proyecto
language_code (string) – Código de idioma

Parámetros de Solicitud:

filter (string) – Subcadena opcional que no distingue entre mayúsculas y minúsculas para filtrar componentes por indicación (por ejemplo, ?filter=core coincidirá con componentes que tengan “core” en cualquier lugar de su indicación); sólo se incluirán en la descarga los componentes cuyas indicaciones contengan la subcadena.
format (string) – El formato de archivador para utilizar; si no está especificado, por defecto a zip; Formatos admitidos: zip y zip:CONVERSION donde CONVERSION es uno de listados convertidos en Descargar traducciones.

Nota

Respuestas posibles:

200 OK con el archivo ZIP de traducciones para el idioma especificado en todos los componentes dentro del proyecto. Si ningún componente tiene traducciones para el idioma especificado, se devolverá un archivo ZIP vacío.
403 Forbidden si el usuario no tiene permisos para el proyecto.
404 Not Found si no existe el indicador del proyecto.

Componentes¶

Consejo

Utilice POST /api/projects/(string:project)/components/ para crear componentes nuevos.

GET /api/components/¶: Devuelve un listado de componentes de traducción.

Ver también

Los atributos del objeto componente están documentados en GET /api/components/(string:project)/(string:component)/.

GET /api/components/(string: project)/(string: component)/¶

Devuelve información relativa al componente de traducción.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL

Respuesta de Objeto JSON:

project (object) – el proyecto de traducción; consulte GET /api/projects/(string:project)/
name (string) – Nombre de componente
slug (string) – Indicación del componente
vcs (string) – Sistema de control de versiones
linked_component (string) – el componente cuyo repositorio está enlazado por medio de URL internos de Weblate
repo (string) – Repositorio de código fuente, esto es el evento de URL del repositorio actual incluso cuando es utilizado URL internos de Weblate, utilice linked_component para detectar esta situación
git_export (string) – URL de repositorio exportado
branch (string) – Rama del repositorio, esto es la rama de repositorio actual incluso cuando es utilizado URL internos de Weblate
push (string) – URL de envío al repositorio, esto es la URL del repositorio actual incluso cuando es utilizado URL internos de Weblate
push_branch (string) – Rama a la que enviar, esto es la rama del repositorio actual incluso cuando es utilizado URL internos de Weblate
filemask (string) – Máscara de archivos
template (string) – Archivo de base monolingüe
edit_template (string) – Editar archivo de base
intermediate (string) – Archivo de idioma intermediario
new_base (string) – Plantilla para traducciones nuevas
file_format (string) – Formato de archivo
file_format_params (object) – Parámetros del formato de archivo
license (string) – Licencia de la traducción
agreement (string) – Acuerdo de licencia del contribuidor
new_lang (string) – Adición de traducciones nuevas
language_code_style (string) – Estilo de código de idioma
source_language (object) – objeto de idioma de origen; consulte GET /api/languages/(string:language)/
check_flags (string) – Indicadores de traducción
priority (string) – Prioridad
enforced_checks (string) – Comprobaciones obligatorias
restricted (string) – Acceso restringido
repoweb (string) – Explorador del repositorio
report_source_bugs (string) – Dirección para informar de errores en las cadenas de origen
merge_style (string) – Estilo de fusión
commit_message (string) – Consolidar, agregar, eliminar, fusionar, agregar y fusionar mensajes de la solicitud
add_message (string) – Consolidar, agregar, eliminar, fusionar, agregar y fusionar mensajes de la solicitud
delete_message (string) – Consolidar, agregar, eliminar, fusionar, agregar y fusionar mensajes de la solicitud
merge_message (string) – Consolidar, agregar, eliminar, fusionar, agregar y fusionar mensajes de la solicitud
addon_message (string) – Consolidar, agregar, eliminar, fusionar, agregar y fusionar mensajes de la solicitud
pull_message (string) – Consolidar, agregar, eliminar, fusionar, agregar y fusionar mensajes de la solicitud
allow_translation_propagation (string) – Permitir propagación de traducciones
enable_suggestions (string) – Activar sugerencias
suggestion_voting (string) – Votar sugerencias
suggestion_autoaccept (string) – Aceptar sugerencias automáticamente
push_on_commit (string) – Enviar al consolidar
locked (bool) – Si el componente está bloqueado, este campo es de sólo lectura; véase GET /api/components/(string:project)/(string:component)/lock/
commit_pending_age (string) – Antigüedad de cambios por consolidar
auto_lock_error (string) – Bloquear al producirse un error
language_regex (string) – Filtro de idioma
variant_regex (string) – Expresión regular de variantes
is_glossary (bool) – Utilizar como glosario
glossary_color (string) – Color de glosario
repository_url (string) – URL al estado del repositorio; consulte GET /api/components/(string:project)/(string:component)/repository/
translations_url (string) – URL a la lista de traducciones; consulte GET /api/components/(string:project)/(string:component)/translations/
lock_url (string) – URL al estado bloqueado; consulte GET /api/components/(string:project)/(string:component)/lock/
changes_list_url (string) – URL para listado de cambios; consulte GET /api/components/(string:project)/(string:component)/changes/
task_url (string) – URL de una tarea en segundo plano (si corresponde); ver GET /api/tasks/(str:uuid)/
credits_url (string) – URL al listado de reconocimiento del contribuidor; consulte GET /api/components/(string:project)/(string:component)/credits/

Ejemplo de datos JSON:

{
    "branch": "main",
    "file_format": "po",
    "file_format_params": {
        "po_line_wrap": 65535,
        "po_no_location": true
    },
    "filemask": "po/*.po",
    "git_export": "",
    "license": "",
    "license_url": "",
    "name": "Weblate",
    "slug": "weblate",
    "project": {
        "name": "Hello",
        "slug": "hello",
        "source_language": {
            "code": "en",
            "direction": "ltr",
             "population": 159034349015,
            "name": "English",
            "url": "http://example.com/api/languages/en/",
            "web_url": "http://example.com/languages/en/"
        },
        "url": "http://example.com/api/projects/hello/",
        "web": "https://weblate.org/",
        "web_url": "http://example.com/projects/hello/"
    },
    "source_language": {
        "code": "en",
        "direction": "ltr",
        "population": 159034349015,
        "name": "English",
        "url": "http://example.com/api/languages/en/",
        "web_url": "http://example.com/languages/en/"
    },
    "repo": "file:///home/nijel/work/weblate-hello",
    "template": "",
    "new_base": "",
    "url": "http://example.com/api/components/hello/weblate/",
    "vcs": "git",
    "web_url": "http://example.com/projects/hello/weblate/"
}

PATCH /api/components/(string: project)/(string: component)/¶

Edita un componente por una solicitud de PATCH.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL
source_language (string) – Código del idioma de origen del proyecto (opcional)

Solicitud de Objeto JSON:

name (string) – nombre del componente
slug (string) – indicador de componente
repo (string) – URL del repositorio VCS

Ejemplo CURL:

curl \
    --data-binary '{"name": "new name"}' \
    -H "Content-Type: application/json" \
    -H "Authorization: Token TOKEN" \
    PATCH http://example.com/api/projects/hello/components/

Ejemplo de solicitud de JSON:

PATCH /api/projects/hello/components/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{
    "name": "new name"
}

Ejemplo de respuesta en JSON

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{
    "branch": "main",
    "file_format": "po",
    "file_format_params": {
        "po_line_wrap": 65535,
        "po_no_location": true
    },
    "filemask": "po/*.po",
    "git_export": "",
    "license": "",
    "license_url": "",
    "name": "new name",
    "slug": "weblate",
    "project": {
        "name": "Hello",
        "slug": "hello",
        "source_language": {
            "code": "en",
            "direction": "ltr",
            "population": 159034349015,
            "name": "English",
            "url": "http://example.com/api/languages/en/",
            "web_url": "http://example.com/languages/en/"
        },
        "url": "http://example.com/api/projects/hello/",
        "web": "https://weblate.org/",
        "web_url": "http://example.com/projects/hello/"
    },
    "repo": "file:///home/nijel/work/weblate-hello",
    "template": "",
    "new_base": "",
    "url": "http://example.com/api/components/hello/weblate/",
    "vcs": "git",
    "web_url": "http://example.com/projects/hello/weblate/"
}

PUT /api/components/(string: project)/(string: component)/¶

Edita un componente por una solicitud PUT.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL

Solicitud de Objeto JSON:

branch (string) – Rama del repositorio de control de versiones
file_format (string) – formato de archivo de las traducciones
file_format_params (object) – los parámetros relacionados con el archivo
filemask (string) – las máscara de archivos de traducción internos alrepositorio
name (string) – nombre del componente
slug (string) – indicador de componente
repo (string) – URL del repositorio VCS
template (string) – archivo base para traducciones monolingües
new_base (string) – archivo base para añadir traducciones nuevas
vcs (string) – sistema de control de versiones

DELETE /api/components/(string: project)/(string: component)/¶

Elimina un componente.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL

GET /api/components/(string: project)/(string: component)/changes/¶

Devuelve un listado de cambios del componente. Esto es esencialmente un componente de alcance GET /api/changes/ aceptando los mismos parámetros.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL

Respuesta de Objeto JSON:

results (array) – formación de objetos del componente; consulte GET /api/changes/(int:id)/

GET /api/components/(string: project)/(string: component)/file/¶

Added in version 4.9.

Descarga todas las traducciones disponibles asociadas al componente como un archivo del archivador utilizando el formato solicitado.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL

Parámetros de Solicitud:

format (string) – El formato de archivador para utilizar; si no está especificado, por defecto a zip; Formatos admitidos: zip y zip:CONVERSION donde CONVERSION es uno de listados convertidos en Descargar traducciones.

GET /api/components/(string: project)/(string: component)/screenshots/¶

Devuelve un listado de las capturas de pantalla del componente.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL

Respuesta de Objeto JSON:

results (array) – formación de captura de componente; consulte GET /api/screenshots/(int:id)/

GET /api/components/(string: project)/(string: component)/lock/¶

Devuelve el estado de bloqueo del componente.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL

Respuesta de Objeto JSON:

locked (boolean) – si el componente está bloqueado para actualizaciones

Ejemplo de datos JSON:

{
    "locked": false
}

POST /api/components/(string: project)/(string: component)/lock/¶

Establece el estado de bloqueo del componente.

La respuesta es la misma que GET /api/components/(string:project)/(string:component)/lock/.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL

Solicitud de Objeto JSON:

lock – Booleano si bloquear o no.

Ejemplo CURL:

curl \
    -d lock=true \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/components/hello/weblate/repository/

Ejemplo de solicitud de JSON:

POST /api/components/hello/weblate/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"lock": true}

Ejemplo de respuesta en JSON

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{"locked":true}

GET /api/components/(string: project)/(string: component)/repository/¶

Devuelve información sobre el estado del repositorio VCS.

La respuesta es misma en cuanto a GET /api/projects/(string:project)/repository/.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL

Respuesta de Objeto JSON:

needs_commit (boolean) – si hay algún cambio pendiente para consolidar
needs_merge (boolean) – si hay cualquier cambio de desarrollo para fusionar
needs_push (boolean) – si hay algún cambio local para subir
remote_commit (string) – Información de consolidación remota
status (string) – Estado del repositorio VCS como reportado por VCS
merge_failure – Texto describiendo fallo de fusión o nulo si no hay nada

POST /api/components/(string: project)/(string: component)/repository/¶

Realiza la operación dada en un repositorio VCS.

Consulte POST /api/projects/(string:project)/repository/ para documentación.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL

Solicitud de Objeto JSON:

operation (string) – Operación para realizar: uno de push, push, commit, reset, cleanup

Respuesta de Objeto JSON:

result (boolean) – resultado de la operación

Ejemplo CURL:

curl \
    -d operation=pull \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/components/hello/weblate/repository/

Ejemplo de solicitud de JSON:

POST /api/components/hello/weblate/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"operation":"pull"}

Ejemplo de respuesta en JSON

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{"result":true}

GET /api/components/(string: project)/(string: component)/monolingual_base/¶

Descarga el archivo de base para traducciones monolingües.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL

GET /api/components/(string: project)/(string: component)/new_template/¶

Descarga el archivo de plantilla para traducciones nuevas.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL

GET /api/components/(string: project)/(string: component)/translations/¶

Devuelve un listado de objetos de traducción en el componente indicado.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL

Respuesta de Objeto JSON:

results (array) – formación de objetos de traducción; consulte GET /api/translations/(string:project)/(string:component)/(string:language)/

POST /api/components/(string: project)/(string: component)/translations/¶

Crea traducción nueva en el componente dado.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL

Solicitud de Objeto JSON:

language_code (string) – código del idioma de traducción; consulte GET /api/languages/(string:language)/

Respuesta de Objeto JSON:

result (object) – objeto nuevo de traducción creado

Ejemplo CURL:

curl \
    -d language_code=cs \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/projects/hello/components/

Ejemplo de solicitud de JSON:

POST /api/projects/hello/components/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"language_code": "cs"}

Ejemplo de respuesta en JSON

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{
    "failing_checks": 0,
    "failing_checks_percent": 0,
    "failing_checks_words": 0,
    "filename": "po/cs.po",
    "fuzzy": 0,
    "fuzzy_percent": 0.0,
    "fuzzy_words": 0,
    "have_comment": 0,
    "have_suggestion": 0,
    "is_template": false,
    "is_source": false,
    "language": {
        "code": "cs",
        "direction": "ltr",
        "population": 1303174280
        "name": "Czech",
        "url": "http://example.com/api/languages/cs/",
        "web_url": "http://example.com/languages/cs/"
    },
    "language_code": "cs",
    "id": 125,
    "last_author": null,
    "last_change": null,
    "share_url": "http://example.com/engage/hello/cs/",
    "total": 4,
    "total_words": 15,
    "translate_url": "http://example.com/translate/hello/weblate/cs/",
    "translated": 0,
    "translated_percent": 0.0,
    "translated_words": 0,
    "url": "http://example.com/api/translations/hello/weblate/cs/",
    "web_url": "http://example.com/projects/hello/weblate/cs/"
}

GET /api/components/(string: project)/(string: component)/statistics/¶

Devuelve estadísticas paginadas para todas las traducciones del componente.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL

Ver también

Los atributos devueltos están descritos en Estadísticas.

GET /api/components/(string: project)/(string: component)/links/¶

Devuelve proyectos vinculados con un componente.

Added in version 4.5.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL

Respuesta de Objeto JSON:

projects (array) – proyectos asociados; consulte GET /api/projects/(string:project)/

POST /api/components/(string: project)/(string: component)/links/¶

Asociar un proyecto con un componente.

Added in version 4.5.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL

Parámetros del Formulario:

string project_slug – Indicación del proyecto

DELETE /api/components/(string: project)/(string: component)/links/(string: project_slug)/¶

Eliminar la asociación de un proyecto con un componente.

Added in version 4.5.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL
project_slug (string) – Indicador del proyecto a retirar

GET /api/components/(string: project)/(string: component)/credits/¶

Devuelve reconocimientos de contribuidor para un proyecto.

Added in version 5.7.

Parámetros:

project (string) – Indicador de URL del proyecto
start (date) – Marca de tiempo ISO 8601 (obligatoria)
end (date) – Sello de tiempo ISO 8601 (obligatorio)
lang (source_language) – Código de idioma para búsqueda

Respuesta de Objeto JSON:

email (string) – Correo-e del contribuidor
full_name (string) – Nombre completo del contribuidor
change_count (string) – Número de cambios realizados en el intervalo de tiempo

Traducciones¶

GET /api/translations/¶: Devuelve un listado de traducciones.

Ver también

Atributos del objeto de traducción están documentados en GET /api/translations/(string:project)/(string:component)/(string:language)/.

GET /api/translations/(string: project)/(string: component)/(string: language)/¶

Devuelve información relativa a la traducción.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL
language (string) – Código de idioma de la traducción

Respuesta de Objeto JSON:

component (object) – objeto componente; consulte GET /api/components/(string:project)/(string:component)/
failing_checks (int) – número de cadenas que fallan una comprobación
failing_checks_percent (float) – porcentaje de cadenas que fallan una comprobación
failing_checks_words (int) – número de palabras con comprobaciones fallidas
filename (string) – nombre de archivo de la traducción
fuzzy (int) – número de cadenas difusas (marcadas para editar)
fuzzy_percent (float) – porcentaje de cadenas difusas (marcadas para editar)
fuzzy_words (int) – número de palabras en cadenas difusas (marcadas para editar)
have_comment (int) – número de cadenas con un comentario
have_suggestion (int) – número de cadenas con una sugerencia
is_template (boolean) – indica si la traducción tiene una base monolingüe
language (object) – objeto de idioma de origen; consulte GET /api/languages/(string:language)/
language_code (string) – el código de idioma utilizado en el repositorio; puede ser distinto del código de idioma del objeto de idioma
last_author (string) – nombre del último autor
last_change (timestamp) – cronomarcador del último cambio
revision (string) – hash de revisión para el archivo
share_url (string) – URL para compartir que va a la página de participación
total (int) – número total de cadenas
total_words (int) – número total de palabras
translate_url (string) – URL para traducir
translated (int) – número de cadenas traducidas
translated_percent (float) – porcentaje de cadenas traducidas
translated_words (int) – número de palabras traducidas
repository_url (string) – URL del estado de repositorio; consulte GET /api/translations/(string:project)/(string:component)/(string:language)/repository/
file_url (string) – URL del objeto de archivo; consulte GET /api/translations/(string:project)/(string:component)/(string:language)/file/
changes_list_url (string) – URL de cambios en el listado; consulte GET /api/translations/(string:project)/(string:component)/(string:language)/changes/
units_list_url (string) – URL del listado de cadenas; consulte GET /api/translations/(string:project)/(string:component)/(string:language)/units/

Ejemplo de datos JSON:

{
    "component": {
        "branch": "main",
        "file_format": "po",
        "file_format_params": {
            "po_line_wrap": 65535,
            "po_no_location": true
        },
        "filemask": "po/*.po",
        "git_export": "",
        "license": "",
        "license_url": "",
        "name": "Weblate",
        "new_base": "",
        "project": {
            "name": "Hello",
            "slug": "hello",
            "source_language": {
                "code": "en",
                "direction": "ltr",
                "population": 159034349015,
                "name": "English",
                "url": "http://example.com/api/languages/en/",
                "web_url": "http://example.com/languages/en/"
            },
            "url": "http://example.com/api/projects/hello/",
            "web": "https://weblate.org/",
            "web_url": "http://example.com/projects/hello/"
        },
        "repo": "file:///home/nijel/work/weblate-hello",
        "slug": "weblate",
        "template": "",
        "url": "http://example.com/api/components/hello/weblate/",
        "vcs": "git",
        "web_url": "http://example.com/projects/hello/weblate/"
    },
    "failing_checks": 3,
    "failing_checks_percent": 75.0,
    "failing_checks_words": 11,
    "filename": "po/cs.po",
    "fuzzy": 0,
    "fuzzy_percent": 0.0,
    "fuzzy_words": 0,
    "have_comment": 0,
    "have_suggestion": 0,
    "is_template": false,
    "language": {
        "code": "cs",
        "direction": "ltr",
        "population": 1303174280
        "name": "Czech",
        "url": "http://example.com/api/languages/cs/",
        "web_url": "http://example.com/languages/cs/"
    },
    "language_code": "cs",
    "last_author": "Weblate Admin",
    "last_change": "2016-03-07T10:20:05.499",
    "revision": "7ddfafe6daaf57fc8654cc852ea6be212b015792",
    "share_url": "http://example.com/engage/hello/cs/",
    "total": 4,
    "total_words": 15,
    "translate_url": "http://example.com/translate/hello/weblate/cs/",
    "translated": 4,
    "translated_percent": 100.0,
    "translated_words": 15,
    "url": "http://example.com/api/translations/hello/weblate/cs/",
    "web_url": "http://example.com/projects/hello/weblate/cs/"
}

DELETE /api/translations/(string: project)/(string: component)/(string: language)/¶

Elimina una traducción.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL
language (string) – Código de idioma de la traducción

GET /api/translations/(string: project)/(string: component)/(string: language)/changes/¶

Devuelve un listado de cambios de traducción. Esto es esencialmente una traducciones con alcance GET /api/changes/ aceptando los mismos parámetros.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL
language (string) – Código de idioma de la traducción

Respuesta de Objeto JSON:

results (array) – formación de objetos del componente; consulte GET /api/changes/(int:id)/

GET /api/translations/(string: project)/(string: component)/(string: language)/units/¶

Devuelve un listado de unidades de traducción.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL
language (string) – Código de idioma de la traducción
q (string) – Cadena de solicitud de búsqueda Búsquedas (opcional)

Respuesta de Objeto JSON:

results (array) – formación de objetos de componente; consulte GET /api/units/(int:id)/

POST /api/translations/(string: project)/(string: component)/(string: language)/units/¶

Añadir nueva unidad.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL
language (string) – Código de idioma de la traducción

Solicitud de Objeto JSON:

key (string) – Clave Traducciones monolingües: de unidad de traducción
value (array) – Traducciones monolinguas: Cadenas de origen (utiliza cadena única si no crea plural)
context (string) – Traducciones bilingües: Contexto de una unidad de traducción
source (array) – Traducciones bilingües: Cadenas origen (utiliza cadena simple si no crea plural)
target (array) – Traducciones bilingües: Cadenas destino (utiliza cadena simple si no crea plural)
state (int) – Estado de cadena; consulte GET /api/units/(int:id)/

Respuesta de Objeto JSON:

unit (object) – unidad recién creada; véase GET /api/units/(int:id)/

Ver también

POST /api/translations/(string: project)/(string: component)/(string: language)/autotranslate/¶

Distinto en la versión 5.13: El parámetro filter_type no está más mantenido y filtrado es hecho por el parámetro q.

Disparador de traducción automática.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL
language (string) – Código de idioma de la traducción

Solicitud de Objeto JSON:

mode (string) – Modo de traducción automatizada
q (string) – Cadena de búsqueda de traducción automática, consulte Searching for strings.
auto_source (string) – Fuente de traducción automática - mt u others
component (string) – Permita que el proyecto contribuya a la memoria de traducción compartida para obtener acceso a componentes adicionales.
engines (array) – Motores de máquinas de traducción
threshold (string) – Umbral de puntuación

GET /api/translations/(string: project)/(string: component)/(string: language)/file/¶

Descarga el archivo de la traducción actual como se esté almacenada en el VCS (sin el parámetro de format) o convertido a otro formato (consulte Descargar traducciones).

Nota

Este punto final de la API utiliza una lógica de salida diferente a la del resto del API, ya que opera con el archivo completo en lugar de con los datos. El conjunto de parámetros de formato format aceptados difiere y, sin dicho parámetro, se obtiene el archivo de traducción tal como está almacenado en el VCS.

Cabeceras de Respuesta:

Last-Modified – Marca de tiempo del último cambio en este archivo.

Cabeceras Solicitadas:

If-Modified-Since – Omite la respuesta si el archivo no se ha modificado desde ese momento.

Parámetros de Solicitud:

format – Formato de archivo a utilizar; si no especificó ningún formato de conversión sucedida; consulte Descargar traducciones para formatos admitidos
q (string) – Filtro descargó cadenas, consulte Página de Búsqueda, solo aplicable cuando la conversión está en su sitio (format está especificado).

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL
language (string) – Código de idioma de la traducción

POST /api/translations/(string: project)/(string: component)/(string: language)/file/¶

Sube archivo nuevo con traducciones.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL
language (string) – Código de idioma de la traducción

Parámetros del Formulario:

string conflicts – Como tratar con conflictos (ignore, replace-translated o replace-approved), consulte Conflicts handling
file file – Archivo subido
string email – Correo-e del autor
string author – Nombre del autor
string method – Método de subida (translate, approve, suggest, fuzzy, replace, source, add), consulte Métodos de importación
string fuzzy – Cadenas difusas (marcadas para editar) procesando (empty, process, approve)

Ejemplo CURL:

curl -X POST \
    -F file=@strings.xml \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/translations/hello/android/cs/file/

GET /api/translations/(string: project)/(string: component)/(string: language)/repository/¶

Devuelve información sobre el estado del repositorio VCS.

La respuesta es la misma que para GET /api/components/(string:project)/(string:component)/repository/.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL
language (string) – Código de idioma de la traducción

POST /api/translations/(string: project)/(string: component)/(string: language)/repository/¶

Efectúa la operación indicada en el repositorio del sistema de control de versiones.

Consulte POST /api/projects/(string:project)/repository/ para documentación.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL
language (string) – Código de idioma de la traducción

Solicitud de Objeto JSON:

operation (string) – Operación para realizar: uno de push, push, commit, reset, cleanup

Respuesta de Objeto JSON:

result (boolean) – resultado de la operación

GET /api/translations/(string: project)/(string: component)/(string: language)/statistics/¶

Devuelve estadísticas detalladas sobre la traducción.

Parámetros:

project (string) – Indicador de URL del proyecto
component (string) – Indicación del componente URL
language (string) – Código de idioma de la traducción

Ver también

Los atributos devueltos están descritos en Estadísticas.

Memoria¶

Added in version 4.14.

GET /api/memory/¶: Devuelve una lista con los resultados de la memoria.

DELETE /api/memory/(int: memory_object_id)/¶

Elimina un objeto de la memoria

Parámetros:

memory_object_id – ID de Objeto de Memoria

Unidades¶

Una unidad es una pieza única de una traducción que empareja una cadena de origen con su correspondiente cadena traducida y que también contiene metadatos relacionados. El término deriva de translate.storage.base.TranslationUnit en Translate Toolkit y XLIFF.

GET /api/units/¶

Devuelve un listado de unidades de traducción.

Parámetros:

q (string) – Cadena de solicitud de búsqueda Búsquedas (opcional)

Ver también

Los atributos del objeto de unidad están documentados en GET /api/units/(int:id)/.

GET /api/units/(int: id)/¶

Distinto en la versión 4.3: El destino target y el origen source ahora son formaciones para manipular apropiadamente cadenas plural.

Distinto en la versión 5.6: El atributo last_updated ahora está expuesto.

Devuelve información relativa a la unidad de traducción.

Parámetros:

id (int) – ID de Unidad

Respuesta de Objeto JSON:

translation (string) – URL de un objeto de traducción relacionado
source (array) – cadena de origen
previous_source (string) – cadena de origen previa a la utilizada para la coincidencia difusa
target (array) – cadena de destino
id_hash (string) – identificador único de la unidad
content_hash (string) – identificador único de la cadena de origen
location (string) – lugar de la unidad en el código fuente
context (string) – contexto de la unidad de traducción
note (string) – nota de la unidad de traducción
flags (string) – indicadores de la unidad de traducción
labels (array) – etiquetas de unidades de traducción, disponibles en las unidades de origen
state (int) – estado de la unidad, 0-sin traducir, 10-necesita edición, 20-traducido, 30-aprobado, 100-solo lectura
fuzzy (boolean) – si la unidad está marcada como pendiente de trabajo o revisión
translated (boolean) – indica si la unidad está traducida
approved (boolean) – indica si la traducción está aprobada
position (int) – posición de la unidad en el archivo de traducción
has_suggestion (boolean) – indica si la unidad tiene sugerencias
has_comment (boolean) – indica si la unidad tiene comentarios
has_failing_check (boolean) – indica si la unidad tiene comprobaciones fallidas
num_words (int) – número de palabras de origen
priority (int) – prioridad de traducción; 100 es la predeterminada
id (int) – identificador de unidad
explanation (string) – Explicación de la cadena, disponible en las unidades fuente, consulte Información adicional sobre las cadenas de origen
extra_flags (string) – Adicionales de la cadena de marcas, disponible en unidades fuente, consulte Personalizar el comportamiento mediante indicadores
web_url (string) – URL para editar la unidad
source_unit (string) – Enlace de la unidad fuente; ver GET /api/units/(int:id)/
pending (boolean) – si la unidad está pendiente de escritura
timestamp (timestamp) – antigüedad de cadena
last_updated (timestamp) – última actualización de la cadena

PATCH /api/units/(int: id)/¶

Added in version 4.3.

Realiza una actualización parcial de la unidad de la traducción.

Parámetros:

id (int) – ID de Unidad

Solicitud de Objeto JSON:

state (int) – estado de la unidad, 0-sin traducir, 10-necesita edición, 20-traducido, 30-aprobado (necesita flujo de trabajo de revisión habilitado, ver Revisores dedicados)
target (array) – cadena de destino
explanation (string) – Explicación de la cadena, disponible en las unidades fuente, consulte Información adicional sobre las cadenas de origen
extra_flags (string) – Adicionales de la cadena de marcas, disponible en unidades fuente, consulte Personalizar el comportamiento mediante indicadores
labels (array) – etiquetas, disponibles en las unidades fuente

PUT /api/units/(int: id)/¶

Added in version 4.3.

Realiza una actualización completa en la unidad de traducción.

Parámetros:

id (int) – ID de Unidad

Solicitud de Objeto JSON:

state (int) – estado de la unidad, 0-sin traducir, 10-necesita edición, 20-traducido, 30-aprobado (necesita flujo de trabajo de revisión habilitado, ver Revisores dedicados)
target (array) – cadena de destino
explanation (string) – Explicación de la cadena, disponible en las unidades fuente, consulte Información adicional sobre las cadenas de origen
extra_flags (string) – Adicionales de la cadena de marcas, disponible en unidades fuente, consulte Personalizar el comportamiento mediante indicadores
labels (array) – etiquetas, disponibles en las unidades fuente

DELETE /api/units/(int: id)/¶

Added in version 4.3.

Elimina una unidad para la traducción.

Parámetros:

id (int) – ID de Unidad

GET /api/units/(int: id)/translations/¶: Added in version 5.11.

Devuelve una lista de todas las unidades de traducción de destino para la unidad de traducción de origen dada.

POST /api/units/(int: id)/comments/¶

Added in version 5.12.

Crear un nuevo comentario en la unidad de traducción dada.

Parámetros:

id (int) – ID de Unidad

Solicitud de Objeto JSON:

scope (string) – alcance del comentario: global, traducción( disponible en todas las unidades que no son de origen), informe (necesita habilitar el flujo de trabajo de revisión, ver Revisores dedicados)
comment (string) – contenido del nuevo comentario, puede utilizar Markdown y mencionar a otros usuarios por @nombredeusuario.
user_email (string) – el correo electrónico del comentarista, se puede configurar sólo por los administradores de proyectos y por defecto al usuario autenticado.
timestamp (string) – timetamp de creación del comentario, sólo lo pueden configurar los administradores de proyectos y predeterminados.

Respuesta de Objeto JSON:

id (int) – identificador de comentarios
comment (string) – contenido del nuevo comentario
user (string) – URL del objeto del comentarista
timestamp (string) – tiempo de creación del comentario

GET /api/units/(int: id)/comments/¶

Added in version 5.15.

Devuelve un listado de comentarios sobre una unidad de traducción dada

Parámetros:

id (int) – ID de Unidad

Respuesta de Objeto JSON:

id (int) – identificador de comentarios
comment (string) – contenido del comentario
timestamp (string) – tiempo de creación del comentario
user (string) – URL del objeto del comentarista

Cambios¶

GET /api/changes/¶

Distinto en la versión 4.1: La filtración de cambios se introdujo en la versión 4.1.

Devuelve un listado de cambios a la traducción.

Ver también

Cambia atributos de objeto estén documentados en GET /api/changes/(int:id)/.

Parámetros de Solicitud:

user (string) – Apodo de usuario para filtros
action (int) – Acción para filtrar, se puede utilizar varias veces
timestamp_after (timestamp) – Marca de tiempo con formato ISO 8601 para enumerar los cambios posteriores
timestamp_before (timestamp) – Marca de tiempo con formato ISO 8601 para enumerar los cambios anteriores

GET /api/changes/(int: id)/¶

Devuelve información acerca del cambio de traducción.

Parámetros:

id (int) – Identificador de cambio

Respuesta de Objeto JSON:

unit (string) – URL de un objeto de unidad relacionado
translation (string) – URL de un objeto de traducción relacionado
component (string) – URL de un objeto componente relacionado
user (string) – URL de un objeto de usuario relacionado
author (string) – URL de un objeto de autor relacionado
timestamp (timestamp) – marca de tiempo del suceso
action (int) – identificación numérica de acción
action_name (string) – descripción de texto de acción
target (string) – suceso cambió texto
old (string) – texto anterior
details (object) – detalles adicionales sobre el cambio
id (int) – identificador de cambio

Capturas de pantalla¶

GET /api/screenshots/¶: Devuelve un listado de información de cadenas de capturas de pantalla.

Ver también

Los atributos de los objetos de captura de pantalla están documentados en GET /api/screenshots/(int:id)/.

GET /api/screenshots/(int: id)/¶

Devuelve información sobre una captura de pantalla.

Parámetros:

id (int) – Identificador de captura de pantalla

Respuesta de Objeto JSON:

name (string) – nombre de una captura de pantalla
component (string) – URL de un objeto componente relacionado
file_url (string) – URL para descargar un archivo; ver GET /api/screenshots/(int:id)/file/
units (array) – enlace a la información de la cadena de origen asociada; consulte GET /api/units/(int:id)/

GET /api/screenshots/(int: id)/file/¶

Descargar la imagen de la captura de pantalla.

Parámetros:

id (int) – Identificador de captura de pantalla

POST /api/screenshots/(int: id)/file/¶

Reemplazar la imagen de la captura de pantalla.

Parámetros:

id (int) – Identificador de captura de pantalla

Parámetros del Formulario:

file image – Archivo subido

Ejemplo CURL:

curl -X POST \
    -F image=@image.png \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/screenshots/1/file/

POST /api/screenshots/(int: id)/units/¶

Asociar la cadena de origen con una captura de pantalla.

Parámetros:

id (int) – Identificador de captura de pantalla

Parámetros del Formulario:

string unit_id – ID de Unidad

Respuesta de Objeto JSON:

name (string) – nombre de una captura de pantalla
translation (string) – URL de un objeto de traducción relacionado
file_url (string) – URL para descargar un archivo; ver GET /api/screenshots/(int:id)/file/
units (array) – enlace a la información de la cadena de origen asociada; consulte GET /api/units/(int:id)/

DELETE /api/screenshots/(int: id)/units/(int: unit_id)¶

Quitar la asociación entre la cadena de origen y la captura de pantalla.

Parámetros:

id (int) – Identificador de captura de pantalla
unit_id – Id. de unidad de cadena de origen

POST /api/screenshots/¶

Crea una captura de pantalla nueva.

Parámetros del Formulario:

file image – Archivo subido
string name – Nombre de captura de pantalla
string project_slug – Indicación del proyecto
string component_slug – Indicación del componente
string language_code – Código de idioma

Respuesta de Objeto JSON:

name (string) – nombre de una captura de pantalla
component (string) – URL de un objeto componente relacionado
file_url (string) – URL para descargar un archivo; ver GET /api/screenshots/(int:id)/file/
units (array) – enlace a la información de la cadena de origen asociada; consulte GET /api/units/(int:id)/

PATCH /api/screenshots/(int: id)/¶

Editar información parcial relativa a una captura de pantalla.

Parámetros:

id (int) – Identificador de captura de pantalla

Respuesta de Objeto JSON:

name (string) – nombre de una captura de pantalla
component (string) – URL de un objeto componente relacionado
file_url (string) – URL para descargar un archivo; ver GET /api/screenshots/(int:id)/file/
units (array) – enlace a la información de la cadena de origen asociada; consulte GET /api/units/(int:id)/

PUT /api/screenshots/(int: id)/¶

Editar información completa relativa a una captura de pantalla.

Parámetros:

id (int) – Identificador de captura de pantalla

Respuesta de Objeto JSON:

name (string) – nombre de una captura de pantalla
component (string) – URL de un objeto componente relacionado
file_url (string) – URL para descargar un archivo; ver GET /api/screenshots/(int:id)/file/
units (array) – enlace a la información de la cadena de origen asociada; consulte GET /api/units/(int:id)/

DELETE /api/screenshots/(int: id)/¶

Eliminar captura de pantalla.

Parámetros:

id (int) – Identificador de captura de pantalla

Complementos¶

Added in version 4.4.1.

GET /api/addons/¶: Devuelve un listado de complementos.

Ver también

Los atributos de objeto de complemento se documentan en GET /api/addons/(int:id)/.

GET /api/addons/(int: id)/¶

Devuelve información relativa a los datos de un complemento.

Parámetros:

id (int) – ID del complemento

Respuesta de Objeto JSON:

name (string) – nombre de un complemento
component (string) – URL de un objeto componente relacionado
configuration (object) – Configuración opcional del complemento

Ver también

Complementos

POST /api/components/(string: project)/(string: component)/addons/¶

Crea un complemento nuevo.

Parámetros:

project_slug (string) – Indicación del proyecto
component_slug (string) – Indicación del componente

Solicitud de Objeto JSON:

name (string) – nombre de un complemento
configuration (object) – Configuración opcional del complemento

PATCH /api/addons/(int: id)/¶

Editar información parcial relativa a un complemento.

Parámetros:

id (int) – ID del complemento

Respuesta de Objeto JSON:

configuration (object) – Configuración opcional del complemento

PUT /api/addons/(int: id)/¶

Editar información completa relativa a un complemento.

Parámetros:

id (int) – ID del complemento

Respuesta de Objeto JSON:

configuration (object) – Configuración opcional del complemento

DELETE /api/addons/(int: id)/¶

Eliminar el complemento.

Parámetros:

id (int) – ID del complemento

Listas de componentes¶

Added in version 4.0.

GET /api/component-lists/¶: Devuelve un listado de listas de componentes.

Ver también

Los atributos de objetos del listado de componentes son documentados en GET /api/component-lists/(str:slug)/.

GET /api/component-lists/(str: slug)/¶

Devuelve información relativa a la lista de componentes.

Parámetros:

slug (string) – Indicador de listado del componente

Respuesta de Objeto JSON:

name (string) – nombre de una lista de componentes
slug (string) – indicador de un listado de componente
show_dashboard (boolean) – si mostrarlo en un cuadro de mando
components (array) – enlaza a componentes asociados; consulte GET /api/components/(string:project)/(string:component)/
auto_assign (array) – reglas de asignación automáticas

PUT /api/component-lists/(str: slug)/¶

Cambia los parámetros de la lista de componentes.

Parámetros:

slug (string) – Indicador de listado del componente

Solicitud de Objeto JSON:

name (string) – nombre de una lista de componentes
slug (string) – indicador de un listado de componente
show_dashboard (boolean) – si mostrarlo en un cuadro de mando

PATCH /api/component-lists/(str: slug)/¶

Cambia los parámetros de la lista de componentes.

Parámetros:

slug (string) – Indicador de listado del componente

Solicitud de Objeto JSON:

name (string) – nombre de una lista de componentes
slug (string) – indicador de un listado de componente
show_dashboard (boolean) – si mostrarlo en un cuadro de mando

DELETE /api/component-lists/(str: slug)/¶

Elimina la lista de componentes.

Parámetros:

slug (string) – Indicador de listado del componente

GET /api/component-lists/(str: slug)/components/¶

Added in version 5.0.1: Enumere los componentes en una lista de componentes.

indicador paramétrico:: Indicador de listado del componente
tipo indicador:: cadena
formulario de cadena component_id:: Identificador de componente
>json array results:: formación de objetos componentes; consulte GET /api/components/(string:project)/(string:component)/

POST /api/component-lists/(str: slug)/components/¶

Asociar un componente con un listado del componente.

Parámetros:

slug (string) – Indicador de listado del componente

Parámetros del Formulario:

string component_id – Identificador de componente

DELETE /api/component-lists/(str: slug)/components/(str: component_slug)¶

Desasocia un componente desde el listado del componente.

Parámetros:

slug (string) – Indicador de listado del componente
component_slug (string) – Indicación del componente

Glosario¶

Distinto en la versión 4.5: Los glosarios se almacenan ahora como componentes regulares, traducciones y cadenas, por favor utilice el API respectivo en su lugar.

Tareas¶

Added in version 4.4.

GET /api/tasks/¶: La enumeración de las tareas no está disponible actualmente.

GET /api/tasks/(str: uuid)/¶

Devuelve información relativa a una tarea.

Parámetros:

uuid (string) – UUID de la tarea

Respuesta de Objeto JSON:

completed (boolean) – Indica si la tarea se ha completado
progress (int) – Progreso de la tarea expresado en porcentaje
result (object) – Resultado de la tarea o detalles de progreso
log (string) – Registro de tareas

Estadísticas¶

GET /api/(str: object)/statistics/¶

Hay varios puntos finales de estadísticas para objetos y todos ellos contienen la misma estructura.

Parámetros:

object (string) – Ruta URL

Respuesta de Objeto JSON:

total (int) – número total de cadenas
total_words (int) – número total de palabras
total_chars (int) – total de caracteres
last_change (timestamp) – fecha del último cambio
translated (int) – número de cadenas traducidas
translated_percent (float) – porcentaje de cadenas traducidas
translated_words (int) – número de palabras traducidas
translated_words_percent (float) – porcentaje de palabras traducidas
translated_chars (int) – número de caracteres traducidos
translated_chars_percent (float) – porcentaje de caracteres traducidos
fuzzy (int) – número de cadenas difusas (marcadas para editar)
fuzzy_words (int) – número de palabras difusas (marcadas para editar)
fuzzy_chars (int) – número de caracteres difusos (marcadas para editar)
fuzzy_percent (float) – porcentaje de cadenas difusas (marcadas para editar)
fuzzy_words_percent (float) – porcentaje de palabras difusas (marcadas para edición)
fuzzy_chars_percent (float) – porcentaje de caracteres difusos (marcados para editar)
failing (int) – número de comprobaciones fallidas
failing_percent (float) – porcentaje de comprobaciones fallidas
approved (int) – número de cadenas aprobadas
approved_words (int) – número de palabras aprobadas
approved_chars (int) – número de caracteres aprobados
approved_percent (float) – porcentaje de cadenas aprobadas
approved_words_percent (float) – porcentaje de palabras aprobadas
approved_chars_percent (float) – porcentaje de caracteres aprobados
readonly (int) – número de cadenas de sólo lectura
readonly_words (int) – número de palabras de sólo lectura
readonly – número de caracteres de sólo lectura
readonly_percent (float) – porcentaje de cadenas de sólo lectura
readonly_words_percent (float) – porcentaje de palabras de solo-lectura
readonly_char_percent (float) – porcentaje de caracteres de sólo lectura
suggestions (int) – número de cadenas con sugerencias
comments (int) – número de cadenas con comentarios
name (string) – nombre del objeto
url (string) – Dirección URL de acceso al objeto (si procede)
url_translate (string) – Dirección URL para acceder a la traducción (si procede)
code (string) – código del idioma (si procede)

Ver también

GET /api/languages/(string:language)/statistics/
GET /api/projects/(string:project)/statistics/
GET /api/categories/(int:id)/statistics/
GET /api/components/(string:project)/(string:component)/statistics/
GET /api/translations/(string:project)/(string:component)/(string:language)/statistics/

Métrica¶

GET /api/metrics/¶

Devuelve métricas de servidor.

Distinto en la versión 5.6.1: Métricas ahora pueden ser expuestas en formato compatible OpenMetrics con ?format=openmetrics.

Respuesta de Objeto JSON:

units (int) – Número de unidades
units_translated (int) – Número de unidades traducidas
users (int) – Número de usuarios
changes (int) – Cantidad de cambios
projects (int) – Cantidad de proyectos
components (int) – Cantidad de componentes
translations (int) – Cantidad de traducciones
languages (int) – Cantidad de idiomas utilizados
checks (int) – Cantidad de los controles de calidad activados
configuration_errors (int) – Cantidad de errores en la configuración
suggestions (int) – Cantidad de sugerencias pendientes
celery_queues (object) – Longitudes de las colas Celery, consulte Tareas en segundo plano con Celery
name (string) – Nombre del servidor configurado

Buscar¶

GET /api/search/¶

Added in version 4.18.

Devuelve resultado de búsqueda por todo el sitio como un listado. No hay paginación en el resultado, solo son devueltos los pocos primeros que coincidan para cada categoría.

La búsqueda busca:

Proyectos
Categorías
Componentes
Idiomas
Usuarios

Parámetros:

q – Buscar cadena solicitada

Respuesta de Objeto JSON:

name (str) – Nombre del ítem coincidente.
url (str) – URL de web del elemento coincidido.
category (str) – Categoría del elemento coincidido.

Categorías¶

GET /api/categories/¶: Added in version 5.0.

Listados de categorías disponibles. Consulte GET /api/categories/(int:id)/ para definiciones de campo.

POST /api/categories/¶: Added in version 5.0.

Crea una categoría nueva. Consulte GET /api/categories/(int:id)/ para definiciones de campo.

GET /api/categories/(int: id)/¶

Added in version 5.0.

Parámetros:

id (int) – ID Categoría

Respuesta de Objeto JSON:

name (str) – Nombre de categoría.
slug (str) – Indicador de categoría.
project (str) – Enlace a un proyecto.
category (str) – Enlaza a una categoría antecesora.

PATCH /api/categories/(int: id)/¶

Added in version 5.0: Editar información parcial sobre categoría.

id parámetro:: ID Categoría
id de tipo:: int
>json object configuration:: Configuración de categoría opcional

PUT /api/categories/(int: id)/¶

Added in version 5.0: Editar información completa sobre categoría.

id parámetro:: ID Categoría
id de tipo:: int
>json object configuration:: Configuración de categoría opcional

DELETE /api/categories/(int: id)/¶

Added in version 5.0: Elimina categoría.

id parámetro:: ID Categoría
id de tipo:: int

GET /api/categories/(int: id)/statistics/¶

Added in version 5.5.

Devuelve estadísticas para una categoría.

Parámetros:

project (int) – ID Categoría

Ver también

Los atributos devueltos están descritos en Estadísticas.

Actuadores de notificación¶

Los actuadores de notificación permiten a aplicaciones externas notificar a Weblate de que se ha actualizado un repositorio de control de versiones.

Puede utilizar puntos finales de repositorio para proyectos, componentes y traducciones para actualizar repositorios individuales; consulte POST /api/projects/(string:project)/repository/ para la documentación.

GET /hooks/update/(string: project)/(string: component)/¶: Obsoleto desde la versión 2.6: Utilice POST /api/components/(string:project)/(string:component)/repository/ en lugar de cual funciona apropiadamente con la autenticación para proyectos limitados por ACL.

Removed in version 5.14.

GET /hooks/update/(string: project)/¶: Obsoleto desde la versión 2.6: Utilice POST /api/projects/(string:project)/repository/ en lugar de cual funciona apropiadamente con la autenticación para proyectos limitados por ACL.

Removed in version 5.14.

POST /hooks/github/¶

Gancho especial para manipular notificaciones GitHub y actualizar automáticamente componentes que coincidan.

Nota

GitHub incluyen mantenimiento directo para notificar Weblate: habilita gancho de servicio Weblate en ajustes de repositorio y establece el URL para el URL de su instalación de Weblate.

Ver también

Recibir cambios automáticamente de GitHub: Para instrucción en configurar integración de GitHub
https://docs.github.com/en/get-started/customizing-your-github-workflow/exploring-integrations/about-webhooks: Información genérica sobre los actuadores web de GitHub
ENABLE_HOOKS: Para activar actuadores en todo Weblate

POST /hooks/gitlab/¶

Gancho especial para manipular notificaciones de GitLab y actualizar automáticamente componentes coincidentes.

Ver también

Recibiendo cambios automáticamente desde GitLab: Para instrucción sobre configurar integración de GitLab
https://docs.gitlab.com/user/project/integrations/webhooks/: Información genérica sobre GitLab Webhooks
ENABLE_HOOKS: Para activar actuadores en todo Weblate

POST /hooks/bitbucket/¶

Gancho especial para manipular notificaciones Bitbucket y actualizar automáticamente componentes coincidentes.

Ver también

Recibir cambios automáticamente de Bitbucket: Para obtener instrucciones sobre cómo configurar la integración de Bitbucket
https://support.atlassian.com/bitbucket-cloud/docs/manage-webhooks/: Información genérica sobre los Webhooks de Bitbucket
ENABLE_HOOKS: Para activar actuadores en todo Weblate

POST /hooks/pagure/¶

Gancho especial para manejar notificaciones de páginas y actualizar automáticamente los componentes coincidentes.

Ver también

Recibir cambios automáticamente de Pagure: Para instrucción sobre cómo configurar la integración de Pagure
https://docs.pagure.org/pagure/usage/using_webhooks.html: Información genérica sobre los Webhooks de Pagure
ENABLE_HOOKS: Para activar actuadores en todo Weblate

POST /hooks/azure/¶

Gancho especial para manipular notificaciones de Azure DevOps y actualizar automáticamente los componentes que correspondan.

Nota

Cerciórese de que Detalles de recursos que enviar esté configurada como Todo; de lo contrario, Weblate no podrá encontrar su repositorio de Azure.

Ver también

Recibir cambios automáticamente de Azure Repos: Para obtener instrucciones sobre cómo configurar la integración de Azure
https://learn.microsoft.com/es/azure/devops/service-hooks/services/webhooks?view=azure-devops: Información genérica sobre los actuadores web de Azure DevOps
ENABLE_HOOKS: Para activar actuadores en todo Weblate

POST /hooks/gitea/¶

Gancho especial para gestionar las notificaciones de Gitea Webhook y actualizar automáticamente los componentes coincidentes.

Ver también

Recibir cambios automáticamente desde Repos de Gitea: Para obtener instrucciones sobre cómo configurar la integración de Gitea
https://docs.gitea.io/es/webhooks/: Información genérica sobre los actuadores web de Gitea
ENABLE_HOOKS: Para activar actuadores en todo Weblate

POST /hooks/gitee/¶

Gancho especial para manipular notificaciones de Webhook de Gitee y actualizar automáticamente los componentes que coincidan.

Ver también

Recibir cambios automáticamente desde Repos Gitee: Para la instrucción sobre la configuración de integración Gitee
https://gitee.com/help/categories/40: Información genérica sobre los actuadores web de Gitee
ENABLE_HOOKS: Para activar actuadores en todo Weblate

Sindicación RSS¶

Las modificaciones a las traducciones se exportan en suministros RSS.

GET /exports/rss/(string: project)/(string: component)/(string: language)/¶: Recupera el suministro RSS de los cambios recientes de una traducción.

GET /exports/rss/(string: project)/(string: component)/¶: Recupera el suministro RSS de los cambios recientes de un componente.

GET /exports/rss/(string: project)/¶: Recupera el suministro RSS de los cambios recientes de un proyecto.

GET /exports/rss/language/(string: language)/¶: Recupera el suministro RSS de los cambios recientes de un idioma.

GET /exports/rss/¶: Recupera el suministro RSS de los cambios recientes de la instalación de Weblate.

Ver también

RSS on Wikipedia