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ía funcionar, pero la API aún está 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 un encabezado HTTP con la clave "MediaWiki-API-Error" y ambos valores, del encabezado y el código de error, se establecerán en el mismo valor. Para más información, véase API: Errores y advertencias.

Parámetros:
action

Qué acción se realizará.

Uno de los siguientes valores: block, checktoken, clearhasmsg, compare, createaccount, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, login, logout, managetags, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, revisiondelete, rollback, rsd, setnotificationtimestamp, stashedit, tag, tokens, unblock, undelete, upload, userrights, watch
Predeterminado: help
format

El formato de la salida.

Uno de los siguientes valores: dbg, dbgfm, json, jsonfm, none, php, phpfm, rawfm, txt, txtfm, xml, xmlfm, yaml, yamlfm
Predeterminado: jsonfm
maxlag

Maximum lag can be used when MediaWiki is installed on a database replicated cluster. To save actions causing any more site replication lag, this parameter can make the client wait until the replication lag is less than the specified value. In case of excessive lag, error code maxlag is returned with a message like Waiting for $host: $lag seconds lagged.
See Manual: Maxlag parameter for more information.

Tipo: entero
smaxage

Establece el encabezado s-maxage durante estos segundos. Los errores nunca se almacenan en caché.

Tipo: entero
Predeterminado: 0
maxage

Establece el encabezado max-age durante estos 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
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

When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body). This must match one of the origins in the Origin header exactly, so it has to be set to something like https://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match the Origin header, a 403 response will be returned. If this parameter matches the Origin header and the origin is whitelisted, an Access-Control-Allow-Origin header will be set.

uselang

Language to use for message translations. A list of codes may be fetched from action=query&meta=siteinfo with siprop=languages, or specify user to use the current user's language preference, or specify content to use this wiki's content language.

Predeterminado: user
Ejemplos:
Ayuda del módulo principal
api.php?action=help
Toda la ayuda en una página
api.php?action=help&recursivesubmodules=1
Permisos:
writeapi
Hacer uso de la API de escritura
Concedidos a: all, 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:

booleano
Los parámetros booleanos trabajo como casillas de verificación HTML: 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 con la fecha y la hora, se recomienda. Todas las horas están en UTC, la inclusión de la zona horaria es ignorada.
  • ISO 8601 con fecha y hora, 2001-01-15T14:56:00Z (signos de puntuación y Z son opcionales)
  • ISO 8601 fecha y hora (se omite) fracciones de segundo, 2001-01-15T14:56:00.00001Z (guiones, dos puntos y, Z son opcionales)
  • Formato MediaWiki, 20010115145600
  • Formato numérico genérico, 2001-01-15 14:56:00 (opcional en la zona horaria GMT, +##, o -## se omite)
  • 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-enero-2001 14:56:00
  • Formato C ctime, lunes enero 15 14:56:00 de 2001
  • Segundos desde 1970-01-01T00:00:00Z como de 1 a 13, dígito entero

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/.

Obtenido de «https://wiki.fjra.es/wiki/Especial:ApiHelp»