Diferencia entre revisiones de «MediaWiki Api»
(Página creada con «Mediawiki trae consigo unos servicios REST expuestos para realizar diferentes operaciones contra la wiki entre ellas esta creación o edición de página, creación de usua…») |
|||
| Línea 5: | Línea 5: | ||
=== 1. Obtener tokens === | === 1. Obtener tokens === | ||
| − | Se debe obtener un token haciendo un consumo GET al servicio: /wiki/api.php?action=query&meta=tokens&type=login|patrol|csrf&format=json, este servicio no recibe parámetros adicionales de los que ya van en la url, el parametro llamado type en este caso tiene tres valores (type=login|patrol|csrf) esto es usado para que nos retorne los diferentes tokens que vamos a necesitar para las diferentes operaciones, login: el token para autenticarnos, patrol: para la creación de usuario, csrf: para la modificación o creación de páginas. | + | Se debe obtener un token haciendo un consumo GET al servicio: /wiki/api.php?action=query&meta=tokens&type=login|patrol|csrf&format=json, este servicio no recibe parámetros adicionales de los que ya van en la url, el parametro llamado type en este caso tiene tres valores (type=login|patrol|csrf) esto es usado para que nos retorne los diferentes tokens que vamos a necesitar para las diferentes operaciones, login: el token para autenticarnos, patrol: para la creación de usuario, csrf: para la modificación o creación de páginas.[[Archivo:GetToken.jpg|miniaturadeimagen|843x843px|Postman obtener tokens|alt=|centro]] |
| − | [[Archivo:GetToken.jpg|miniaturadeimagen|843x843px|Postman obtener tokens]] | + | |
| + | === 2. Login === | ||
| + | Para autenticarse vamos a necesitar el logintoken obtenido en el paso 1, el usuario y la contraseña, para hacer un POST a /wiki/api.php?action=login&format=json, los para se deben enviar como form-data , no como JSON | ||
| + | |||
| + | ==== Parametros ==== | ||
| + | lgname: nombre del usuario | ||
| + | |||
| + | lgpassword: contraseña del usuario | ||
| + | |||
| + | lgtoken: login token obtenido del paso 1 | ||
| + | |||
| + | [[Archivo:Login.jpg|centro|marco|Ejemplo de login]] | ||
| + | |||
| + | == Creación o edición de páginas == | ||
| + | Para hacer la creación o edición de páginas se requiere que la persona se haya autenticado con el paso anterior, | ||
| + | |||
| + | === Parámetros requeridos: === | ||
| + | |||
| + | # token: en este necesitaremos el csrftoken del servicio de autenticación. | ||
| + | # title: titulo de la pagina | ||
| + | # summary: el resumen de lo que es la página | ||
| + | # text: el contenido de la página | ||
| + | |||
| + | Nota: para la lista de parámetros visita: [http://wiki.softcaribbean.com/wiki/api.php?action=help&modules=edit Ayuda de la API de MediaWiki - Softcaribbean Wiki] | ||
| + | [[Archivo:CrearPagina.jpg|centro|marco|Ejemplo de creación de página]] | ||
Revisión del 12:43 23 mar 2021
Mediawiki trae consigo unos servicios REST expuestos para realizar diferentes operaciones contra la wiki entre ellas esta creación o edición de página, creación de usuarios entre otras cosas.
Autenticación
Para hacer uso de cualquier servicio (esto solo aplica si la wiki es privada como el caso de la de Softcaribbean) se requiere siempre estar autenticado en los servicios. Para realizar este proceso se debe hacer en dos consumos:
1. Obtener tokens
Se debe obtener un token haciendo un consumo GET al servicio: /wiki/api.php?action=query&meta=tokens&type=login|patrol|csrf&format=json, este servicio no recibe parámetros adicionales de los que ya van en la url, el parametro llamado type en este caso tiene tres valores (type=login|patrol|csrf) esto es usado para que nos retorne los diferentes tokens que vamos a necesitar para las diferentes operaciones, login: el token para autenticarnos, patrol: para la creación de usuario, csrf: para la modificación o creación de páginas.
2. Login
Para autenticarse vamos a necesitar el logintoken obtenido en el paso 1, el usuario y la contraseña, para hacer un POST a /wiki/api.php?action=login&format=json, los para se deben enviar como form-data , no como JSON
Parametros
lgname: nombre del usuario
lgpassword: contraseña del usuario
lgtoken: login token obtenido del paso 1
Creación o edición de páginas
Para hacer la creación o edición de páginas se requiere que la persona se haya autenticado con el paso anterior,
Parámetros requeridos:
- token: en este necesitaremos el csrftoken del servicio de autenticación.
- title: titulo de la pagina
- summary: el resumen de lo que es la página
- text: el contenido de la página
Nota: para la lista de parámetros visita: Ayuda de la API de MediaWiki - Softcaribbean Wiki


