MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/API

Módulo principal

Estado: Todas las características que se muestran en esta página deberían funcionar, pero la API aún se encuentra en desarrollo activo y puede cambiar en cualquier momento. Suscríbete a la lista de correo de mediawiki-api-announce para estar al día de las actualizaciones.

Solicitudes erróneas: Cuando se envían solicitudes erróneas a la API, se envía una cabecera HTTP con la clave "MediaWiki-API-Error". El valor de la cabecera y el código de error devuelto tomarán el mismo valor. Para más información, véase API: Errores y advertencias.

Pruebas: para facilitar las pruebas de solicitudes a la API, consulta Special:ApiSandbox.

Parámetros:
action

Qué acción se realizará.

Uno de los siguientes valores: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, antispoof, block, changeauthenticationdata, checktoken, clearhasmsg, clientlogin, compare, createaccount, cspreport, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, linkaccount, login, logout, managetags, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, spamblacklist, stashedit, tag, titleblacklist, tokens, unblock, undelete, unlinkaccount, upload, userrights, watch
Predeterminado: help
format

El formato de la salida.

Uno de los siguientes valores: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Predeterminado: jsonfm
maxlag

El retraso (lag) máximo puede ser utilizado cuando MediaWiki está instalado en un conjunto de bases de datos replicadas. Para evitar cualquier acción que pudiera causar un retraso aún mayor en la replicación del sitio, este parámetro puede causar que el cliente espere hasta que el retraso de replicación sea menor que el valor especificado. En caso de exceso de retraso, se devuelve un código de error maxlag con un mensaje similar a Esperando a $host: $lag segundos de retraso.
Véase Manual:Parámetro maxlag para más información.

Tipo: entero
smaxage

Establece el encabezado HTTP s-maxage de control de caché a esta cantidad de segundos. Los errores nunca se almacenan en caché.

Tipo: entero
Predeterminado: 0
maxage

Establece el encabezado HTTP max-age de control de caché a esta cantidad de segundos. Los errores nunca se almacenan en caché.

Tipo: entero
Predeterminado: 0
assert

Comprobar que el usuario haya iniciado sesión si el valor es user o si tiene el permiso de bot si es bot.

Uno de los siguientes valores: user, bot
assertuser

Verificar el usuario actual es el usuario nombrado.

Tipo: nombre de usuario
requestid

Cualquier valor dado aquí se incluirá en la respuesta. Se puede utilizar para distinguir solicitudes.

servedby

Incluir el nombre del host que ha servido la solicitud en los resultados.

Tipo: booleano/lógico (detalles)
curtimestamp

Incluir la marca de tiempo actual en el resultado.

Tipo: booleano/lógico (detalles)
origin

Cuando se accede a la API usando una petición AJAX de distinto dominio (CORS), se establece este valor al dominio de origen. Debe ser incluido en cualquier petición pre-vuelo, y por lo tanto debe ser parte de la URI de la petición (no del cuerpo POST).

En las peticiones con autenticación, debe coincidir exactamente con uno de los orígenes de la cabecera Origin, por lo que debería ser algo como https://en.wikipedia.org o https://meta.wikimedia.org. Si este parámetro no coincide con la cabecera Origin, se devolverá una respuesta 403. Si este parámetro coincide con la cabecera Origin y el origen está en la lista blanca, se creará una cabecera Access-Control-Allow-Origin.

En las peticiones sin autenticación, introduce el valor *. Esto creará una cabecera Access-Control-Allow-Origin, pero el valor de Access-Control-Allow-Credentials será false y todos los datos que dependan del usuario estarán restringidos.

uselang

El idioma que se utilizará para las traducciones de mensajes. action=query&meta=siteinfo con siprop=languages devuelve una lista de códigos de idiomas. También puedes introducir user para usar la preferencia de idioma del usuario actual, o content para usar el idioma de contenido de este wiki.

Predeterminado: user
Ejemplos:
Ayuda del módulo principal
api.php?action=help [open in sandbox]
Toda la ayuda en una página
api.php?action=help&recursivesubmodules=1 [open in sandbox]
Permisos:
writeapi
Hacer uso de la API de escritura
Concedidos a: user, bot
apihighlimits
Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.
Concedidos a: bot, sysop

Tipos de datos

Algunos tipos de parámetros en las solicitudes de API necesita más explicación:

boolean
Los parámetros booleanos trabajo como HTML casillas de verificación: si el parámetro se especifica, independientemente de su valor, se considera verdadero. Para un valor false, se omite el parámetro completo.
marca de tiempo
Las marcas de tiempo se puede especificar en varios formatos. ISO 8601 la fecha y la hora se recomienda. Todas las horas están en UTC, la inclusión de la zona horaria es ignorado.
  • ISO 8601 la fecha y la hora, 2001-01-15T14:56:00Z (signos de puntuación y Z son opcionales)
  • ISO 8601 la fecha y la hora (se omite) fracciones de segundos, 2001-01-15T14:56:00.00001Z (guiones, dos puntos, y, Z son opcionales)
  • MediaWiki formato, 20010115145600
  • Genérico formato numérico, 2001-01-15 14:56:00 (opcional en la zona horaria de GMT, +##, o -## se omite)
  • El formato EXIF, 2001:01:15 14:56:00
  • Formato RFC 2822 (zona horaria se puede omitir), Mon, 15 Ene 2001 14:56:00
  • Formato RFC 850 (zona horaria se puede omitir), lunes, 15-Ene-2001 14:56:00
  • C ctime formato, Mon Jan 15 14:56:00 de 2001
  • Segundos desde 1970-01-01T00:00:00Z como la 1 a la 13 dígito entero (excepto 0)
  • La cadena de ahora

Créditos

Desarrolladores de la API:

  • Roan Kattouw (desarrollador principal, sep. 2007-2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Yuri Astrakhan (creador y desarrollador principal, sep. 2006-sep. 2007)
  • Brad Jorsch (desarrollador principal, 2013-actualidad)

Envía comentarios, sugerencias y preguntas a mediawiki-api@lists.wikimedia.org o informa de un error en https://phabricator.wikimedia.org/.