Diferencia entre revisiones de «MediaWiki Api»

De Kuye Wiki
Ir a la navegación Ir a la búsqueda
 
(No se muestran 2 ediciones intermedias del mismo usuario)
Línea 20: Línea 20:
  
 
== Creación o edición de páginas ==
 
== 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,  
+
Para hacer la creación o edición de páginas se requiere que la persona se haya autenticado con el paso anterior, ya que este paso generan unas cookies que deben ser pasadas a la peticción
  
 
=== Parámetros requeridos: ===
 
=== Parámetros requeridos: ===
  
# token: en este necesitaremos el csrftoken del servicio de autenticación.
+
# token: en este necesitaremos el csrftoken del servicio de autenticación, esto token sale al consumir el servicio de obtener token enviando las cookies de autenticación de lo contrario la respuesta va a ser +//.
 
# title: titulo de la pagina
 
# title: titulo de la pagina
# summary: el resumen de lo que es la página
+
# summary: el resumen de lo que es la página (solo si no es una seccion
# text: el contenido de la página
+
# text: el contenido de la página o sección
 +
# section: es un parámetro opcional si se envía la palabra new, crea una nueva sección en la misma pagina
 +
# sectiontitle: es un parámetro opcional se usa para cuando se establece new en la variable section, para el titulo de la nueva sección
  
 
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]
 
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]]
 
[[Archivo:CrearPagina.jpg|centro|marco|Ejemplo de creación de página]]
 +
 +
== Video ejemplo completo ==
 +
https://artefactory.softcaribbean.com/share/page/context/shared/document-details?nodeRef=workspace://SpacesStore/f9c9df3d-6189-4997-b6c1-6234197c1929

Revisión actual del 15:16 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:

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.

Postman obtener tokens

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

Parámetros requeridos:

lgname: nombre del usuario

lgpassword: contraseña del usuario

lgtoken: login token obtenido del paso 1

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, ya que este paso generan unas cookies que deben ser pasadas a la peticción

Parámetros requeridos:

  1. token: en este necesitaremos el csrftoken del servicio de autenticación, esto token sale al consumir el servicio de obtener token enviando las cookies de autenticación de lo contrario la respuesta va a ser +//.
  2. title: titulo de la pagina
  3. summary: el resumen de lo que es la página (solo si no es una seccion
  4. text: el contenido de la página o sección
  5. section: es un parámetro opcional si se envía la palabra new, crea una nueva sección en la misma pagina
  6. sectiontitle: es un parámetro opcional se usa para cuando se establece new en la variable section, para el titulo de la nueva sección

Nota: para la lista de parámetros visita: Ayuda de la API de MediaWiki - Softcaribbean Wiki

Ejemplo de creación de página

Video ejemplo completo

https://artefactory.softcaribbean.com/share/page/context/shared/document-details?nodeRef=workspace://SpacesStore/f9c9df3d-6189-4997-b6c1-6234197c1929