manual de usuario administrador - Acortador de URLs Junta de

Transcripción

manual de usuario administrador - Acortador de URLs Junta de
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE
URLS
Departamento:
Área:
Tipo de documento:
Mercedes Duarte Madiedo
Técnico
Servicios Telemáticos
Manual
Código:
SDS-DV-43-NA1A2-120918-1
Edición:
3
Fecha:
02/06/14
Fecha de entrada en vigor:
01/11/12
Nº de Páginas:
Elaborado
Ingenieria y C. Calidad
Revisado
1 de 24
Revisado
Nombre
Cargo
Aprobado
Nombre
Cargo
Nombre
Cargo
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento y, en su caso, cualquier documento anexo al mismo, contiene información de carácter confidencial exclusivamente dirigida a
su destinatario o destinatarios. Queda prohibida su divulgación, copia o distribución a terceros sin la previa autorización escrita de “Sociedad
Andaluza para el Desarrollo de las Telecomunicaciones”. Si no es Ud. el destinatario del documento le ruego lo destruya sin hacer copia digital
o física, comunicando a “Sociedad Andaluza para el Desarrollo de la Sociedad de las Telecomunicaciones” vía e-mail o fax la recepción del
presente documento. Toda declaración de voluntad contenida deberá ser tenida por no producida.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 2 de 24
Entrada en vigor: 01/11/12
HOJA DE CONTROL DE EDICIONES
Nº Edición
Fecha
Naturaleza de la edición
0
12/09/18
Edición inicial
1
12/09/25
Incluida gestión del diccionario de palabras prohibidas
2
14/03/03
Actualización del documento a la versión 1.7 del aplicativo
3
02/06/14
Actualización del documento debido a la nueva interfaz de usuario del
aplicativo
Detalles de los cambios de la última edición:
Actualización del documento debido a la nueva interfaz de usuario del aplicativo ajustada a estilos del
Portal corporativo JdA
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
0
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 3 de 24
Entrada en vigor: 01/11/12
INDICE
0 INDICE............................................................................................................................................3
1 OBJETO...........................................................................................................................................4
2 INTRODUCCIÓN...............................................................................................................................5
3 INTERFAZ DE ADMINISTRACIÓN.....................................................................................................6
3.1 Acortar URL..............................................................................................................................6
3.2 Error al acortar URL.................................................................................................................8
3.3 Listado de URLs........................................................................................................................9
3.4 Modificación de URLs...............................................................................................................11
3.5 Eliminación de URLs................................................................................................................12
3.6 Compartir URLs en redes sociales.............................................................................................13
3.7 Visualización de estadísticas de URLs......................................................................................13
4 HERRAMIENTAS DEL SISTEMA......................................................................................................15
5 GESTIÓN DE PLUGINS...................................................................................................................16
5.1 Plugin WhitelistDomains...........................................................................................................17
6 UTILIZACIÓN DEL API.....................................................................................................................18
6.1 Acortar URL............................................................................................................................19
6.2 Obtener la URL larga a partir de un identificador de URL corta............................................20
6.3 Obtener las estadísticas de una URL corta ..........................................................................21
6.4 Obtener las estadísticas de todas las URLs...........................................................................21
6.5 Obtener el número total de URLs y el conteo de ellas.........................................................22
7 RSS...............................................................................................................................................22
8 GESTIÓN DEL DICCIONARIO DE PALABRAS PROHIBIDAS.................................................................23
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
1
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 4 de 24
Entrada en vigor: 01/11/12
OBJETO
La funcionalidad de este manual es servir de guía para la administración del aplicativo Yourls seleccionado para la
implementación del servicio Acortador de URLs. Este aplicativo se instalará como servicio horizontal para la Junta de Andalucía.
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
2
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 5 de 24
Entrada en vigor: 01/11/12
INTRODUCCIÓN
Tras la solicitud de instalación de un servicio de Acortador de URLs para uso interno en la Junta de Andalucía por parte de la
Consejería de Economía, Innovación, Ciencia y Empleo se llevó a cabo una consultoría previa por un proveedor externo para
analizar las diversas soluciones de software libre presentes en el mercado.
Entre las soluciones encontradas se buscaban una serie de características:
– Estabilidad y facilidad de instalación.
– Tipo de licencia.
– Posibilidad de extensión mediante plugins o extensiones.
– Generación de enlaces aleatorios y personalizados.
– API para poder interactuar con otras aplicaciones.
– Prevención contra parámetros extras en la URL.
– Posibilidad de ofrecer un servicio completamente público, donde cualquiera pueda generar URLs, o bien, un
servicio donde exista alguna forma de limitación.
– Control sobre el tipo de redirección.
– Edición de enlaces existentes.
– Estadísticas de acceso para un enlace generado.
– Escalabilidad del sistema.
– Diccionario para evitar palabras malsonantes en los identificadores.
– Identificadores de URLs permanentes
De las soluciones estudiadas se seleccionó la herramienta Yourls ya que cumple con la mayoría de las características
esperadas de este servicio.
Yourls consiste en una serie de scripts en Php que se instalan en el servidor.
Necesita para su instalación de un servidor basado en Apache, Php y MySql.
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
3
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 6 de 24
Entrada en vigor: 01/11/12
INTERFAZ DE ADMINISTRACIÓN
Para acceder a la interfaz de administración del Acortador de URLs se deberá acceder a la siguiente URL desde
cualquier navegador web:
• http://lajunta.es/admin/index.php
• Para acceder a esta pantalla será necesario disponer de usuario/password para su autenticación.
En la pantalla principal de administración del sitio tendremos un pequeño menú en la parte superior de la pantalla,
para acceder a esta pantalla de administración, al manejo de las herramientas de marcadores, a la administración de plugins y
a la pantalla de ayuda de la aplicación.
Bajo este menú se presenta un formulario mediante el cual se podrán acortar las URLs, seguido de una tabla con el
listado de las URLs que mantiene el sistema, además de un formulario de filtrado por diferentes opciones de dichas URLs .
3.1
Acortar URL.
El formulario para acortar URLs se presenta en la pantalla principal de administración:
Dicho formulario consta de dos campos de texto:
– En el primero de ellos se indicará la URL que se desea acortar.
– El segundo campo es opcional. Si no se indica un valor para este campo el sistema asignará aleatóriamente un
identificador para la URL corta a crear.
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 7 de 24
Entrada en vigor: 01/11/12
Una vez creada la URL corta el sistema nos mostrará en pantalla un mensaje satisfactorio, además de mostrarnos
información relativa a la URL recién creada:
– URL larga.
– URL corta.
Asimismo mostrará un cuadro de texto para poder compartir la recién creada URL corta mediante los servicios de
redes sociales Twitter, Facebook o FriendFeed.
Si se selecciona publicar la URL en Twitter aparecerá la siguiente ventana para insertar los datos del usuario que
desee twittear:
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 8 de 24
Entrada en vigor: 01/11/12
Una vez logado en la red social la URL recién creada aparecerá twitteada en su perfil.
De la misma forma se procederá si se desea publicar en Facebook o en FriendFeed.
3.2
Error al acortar URL.
La configuración del sistema no permite tener más de una URL corta para una misma URL larga, por lo que si se
intenta acortar una URL ya presente en el sistema se mostrará un mensaje de error como el siguiente:
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 9 de 24
Entrada en vigor: 01/11/12
Del mismo modo si se intenta establecer un identificador de URL que ya esté presente en el sistema se mostrará el
siguiente mensaje de error:
3.3
Listado de URLs.
En la pantalla principal de administración se presenta una tabla con el listado de las URLs que mantiene el sistema:
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 10 de 24
Entrada en vigor: 01/11/12
Dicho listado está ordenado de forma descendente por fecha de creación de la URL.
En la tabla se muestra diferente información sobre las URLs creadas:
– URL corta: identificador de la URL corta que se corresponde con la URL larga indicada en el campo URL original.
Dicho campo es asimismo un enlace html. Podemos obtener la URL corta completa de este enlace pulsando con
el botón derecho sobre este enlace:
–
–
–
–
–
URL original: en este campo se muestra tanto la URL larga que ha sido acortada como el título de esta URL.
Ambos textos son enlaces a la URL larga.
Fecha: este campo indica la fecha de creación de la URL corta en el sistema.
IP: este campo indica la IP del usuario que creó la URL corta. Este campo se utiliza principalmente para las
estadísticas de geolocalización del sistema.
Clicks: este campo indica el nº de clicks que ha recibido la URL corta.
Acciones: en este campo aparecen una serie de botones que se utilizan para gestionar la URL corta almacenada
en el sistema:
Las acciones que se pueden llevar a cabo sobre las URLs cortas se expondrán en los siguientes puntos.
Bajo la tabla de URLs se encuentra un formulario mediante el cual se pueden hacer tanto búsquedas de texto en los
diferentes campos, como ordenaciones del listado y filtrados de las URLs presentes por número de clicks o por fecha de
creación.
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
3.4
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 11 de 24
Entrada en vigor: 01/11/12
Modificación de URLs.
Para modificar una URL se deberá pulsar el botón de edición del campo acciones del formulario anterior:
Aparecerá bajo la fila de la URL que se quiere modificar un formulario con los datos que pueden ser modificados:
Se modificarán los datos precisos y se pulsará el botón “Guardar” o bien se cancelará la edición pulsando sobre el
botón “Cancelar”.
Se podrán modificar todos los datos del formulario, es decir, URL larga, URL corta y título. El sistema mostrará un
mensaje informando del cambio:
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 12 de 24
Entrada en vigor: 01/11/12
Si al modificar la URL se modifica por una URL larga o una URL corta ya existente en el sistema, éste mostrará un
mensaje indicativo del fallo:
3.5
Eliminación de URLs.
Para eliminar una URL se deberá pulsar el botón de borrado del campo acciones del formulario anterior:
El sistema mostrará un mensaje de confirmación de borrado:
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 13 de 24
Entrada en vigor: 01/11/12
Si el usuario pulsa Aceptar se eliminará la URL del sistema y si pulsa Cancelar se cancelará la eliminación de dicha
URL.
3.6
Compartir URLs en redes sociales.
Para compartir una URL se deberá pulsar el botón compartir del campo acciones del formulario anterior:
Cuando se pulse el botón compartir se mostrarán dos cuadros, uno con información relativa a la URL seleccionada y
otro con opciones para compartir en las redes sociales, tal como se explicó en el punto 3.1:
3.7
Visualización de estadísticas de URLs.
Para ver las estadísticas de una URL se deberá pulsar el botón de estadísticas del campo acciones del formulario
anterior:
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 14 de 24
Entrada en vigor: 01/11/12
Una vez pulsado el botón se redirigirá al usuario a una página de visualización de las estadísticas de la URL
seleccionada. En esta pantalla se presenta la información de la URL seleccionada además de varias pestañas con información:
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 15 de 24
Entrada en vigor: 01/11/12
4
HERRAMIENTAS DEL SISTEMA
Para acceder a la pantalla de herramientas del Acortador de URLs se deberá acceder a la siguiente URL desde
cualquier navegador web:
•
http://lajunta.es/admin/tools.php
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 16 de 24
Entrada en vigor: 01/11/12
Yourls permite añadir a la barra de tareas del navegador marcadores para permitir automatizar la tarea de acortar la
URL actual del navegador. La forma de añadir estos marcadores a la barra de tareas difiere dependiendo del navegador con el
que se trabaje:
– Con Mozilla Firefox y Google Chrome se arrastrarán los marcadores desde su ubicación actual hasta la barra de
tareas del navegador.
– Con Internet Explorer se pulsará con el botón derecho del ratón sobre el marcador que se desee añadir y se
añadirá a los favoritos del explorador.
–
–
–
–
–
Los tipos de marcadores que se pueden añadir al navegador son:
Marcador “Acortar”: al pulsar sobre este marcador se añadirá directamente al sistema Yourls la URL actual del
navegador. La URL corta generada será la siguiente en la secuencia numérica que utiliza Yourls por defecto. El
comportamiento de este botón es redirigir de la URL actual a la pantalla principal de administración de Yourls. Si
la URL ya existe en la base de datos se mostrará un mensaje indicativo en la pantalla de administración.
Marcador “Acortar Instantáneamente”: al pulsar sobre este marcador aparecerá una ventana modal en el
navegador con la URL corta que se va a dar de alta en el sistema para la URL actual del navegador. La URL corta
generada será la siguiente en la secuencia numérica que utiliza Yourls por defecto. No se redirigirá a la URL de
administración de Yourls. Si la URL ya existe en el sistema se mostrará un mensaje indicativo en la ventana
modal. Aunque en la ventana modal aparenta que se puede modificar el identificador de la URL corta
internamente no se estará modificando.
Marcador “Acortar (personalizado)”: al pulsar sobre este marcador aparecerá una ventana modal en el
navegador con un cuadro de texto para que se escriba el identificador de la URL corta que se desea para la URL
actual del navegador. El comportamiento de este botón es redirigir de la URL actual a la pantalla principal de
administración de Yourls. Si la URL ya existe en el sistema se mostrará un mensaje indicativo en la pantalla de
administración.
Marcador “Acortar Instantáneamente (personalizado)”: al pulsar sobre este marcador aparecerá una ventana
modal en el navegador con un cuadro de texto para que se escriba el identificador de la URL corta que se desea
para la URL actual del navegador. No se redirigirá a la URL de administración de Yourls. Si la URL ya existe en el
sistema se mostrará un mensaje indicativo en la ventana modal.
Marcadores sociales: Yourls incluye marcadores para poder realizar el acortamiento de una URL y a su vez
publicarla directamente en las redes sociales. Para ello trae marcadores para Facebook, Twitter y Tumblr.
5
GESTIÓN DE PLUGINS
Para acceder a la pantalla de gestión de plugins del Acortador de URLs se deberá acceder a la siguiente URL desde
cualquier navegador web:
•
http://lajunta.es/admin/plugins.php
Los plugins consisten en módulos que extienden la funcionalidad del aplicativo Yourls. El núcleo de Yourls está
diseñado para ser lo más liviano posible y de esta forma no lleva implementadas funcionalidades que no todo el mundo
necesita.
Al usar los plugins se añaden nuevas características a la instalación de Yourls sin necesidad de modificar su núcleo, lo
que impide que se pierdan los cambios realizados en el caso de una actualización de versión del aplicativo.
Al acceder a la pantalla de gestión de plugins se visualizará un listado de los plugins actualmente disponibles en el
sistema con la posibilidad de habilitarlos o deshabilitarlos.
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 17 de 24
Entrada en vigor: 01/11/12
Para ello solamente será necesario pulsar sobre el enlace Activar/Desactivar en el campo Acción del plugin.
5.1
Plugin WhitelistDomains.
Este plugin se utiliza para mantener una lista de dominios sobre los que se pueden acortar URLs. De esta forma se
restringe el uso del Acortador a estos dominios específicos. Hay que tener en cuenta eliminar la parte “www” de la URL al
añadir un nuevo dominio a la lista.
También permite mantener una lista de usuarios los cuales puedan saltarse esta restricción de dominio a la hora de
acortar sus URLs.
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
6
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 18 de 24
Entrada en vigor: 01/11/12
UTILIZACIÓN DEL API
Yourls, dispone de una API propia que permite utilizar el servicio por aplicaciones terceras.
Para todas las llamadas a la API necesitamos enviar una serie de parámetros vía GET o POST (hay que codificar las
URLs si se envían vía GET).
Entre estos parámetros hay que enviar las credenciales de acceso de los usuarios en el caso en que la aplicación se
haya instalado para uso privado. Las credenciales de acceso se enviarán mediante la tupla username/password del usuario o
mediante un parámetro llamado signature, que es una firma válida. Esta firma se puede consultar en la zona Herramientas de
la pantalla de administración de Yourls si se ha instalado el software para uso privado y es única para cada cuenta.
Para más información: https://github.com/YOURLS/YOURLS/wiki/PasswordlessAPI
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 19 de 24
Entrada en vigor: 01/11/12
A continuación se exponen las diferentes funcionalidades que ofrece el API.
6.1
Acortar URL
Esta llamada generará un identificador de URL corta dada una URL larga. Los parámetros que utiliza esta llamada al
API son:
–
–
action: shorturl. Se indica que la acción a realizar es acortar la URL larga indicada.
url: la URL larga que se desea acortar.
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 20 de 24
Entrada en vigor: 01/11/12
keyword: es un parámetro opcional. Si se pasa este parámetro se tomará como identificador de la URL corta a
crear. Si no se pasa este parámetro se generará un identificador de URL corta por defecto.
– Title: es un parámetro opcional. Si se pasa este parámetro se tomará como título de la URL corta a crear.
– format: es un parámetro opcional que indica el formato de la respuesta devuelto por el API. Puede ser: "jsonp",
"json", "xml" o "simple".
Ejemplos de llamadas:
– http://lajunta.es/yourls-api.php?
action=shorturl&url=http://www.terra.es&format=xml&signature=c4de1bc64e
–
Esta llamada indica al API que se quiere acortar la URL “http://www.terra.es” y que devuelva el resultado de la
operación en formato xml. El resultado sería el siguiente:
<?xml version="1.0" encoding="iso-8859-1"?>
<result>
<url>
<keyword>w</keyword>
<url>http://www.terra.es</url>
<title><![CDATA[Terra Espa&Atilde;&plusmn;a - Noticias, Deportes, Entretenimiento y Estilo de Vida]]></title>
<date>2014-03-04 15:17:59</date>
<ip>10.240.205.73</ip>
</url>
<status>success</status>
<message><![CDATA[http://www.terra.es a&Atilde;&plusmn;adida a la base de datos]]></message>
<title><![CDATA[Terra Espa&Atilde;&plusmn;a - Noticias, Deportes, Entretenimiento y Estilo de Vida]]></title>
<shorturl>http://lajunta.es/w</shorturl>
<statusCode>200</statusCode>
</result>
6.2
Obtener la URL larga a partir de un identificador de URL corta
Esta llamada obtendrá la URL larga asociada al identificador de URL corta que se le pase como parámetro. Los
parámetros que utiliza esta llamada al API son:
– action: expand. Se indica que la acción a realizar es obtener la URL larga de la URL corta que se indica.
– shorturl: URL corta de la cual se quiere obtener la URL larga.
– format: es un parámetro opcional que indica el formato de la respuesta devuelto por el API. Puede ser: "jsonp",
"json", "xml" o "simple".
Ejemplo de llamada:
– http://lajunta.es/yourls-api.php?action=expand&shorturl=jda&format=xml
Esta llamada indica al API que se quiere obtener la URL larga de la URL corta “jda” y que devuelva el resultado de la
operación en formato xml. El resultado sería el siguiente:
<?xml version="1.0" encoding="iso-8859-1"?>
<result>
<keyword>jda</keyword>
<shorturl>http://lajunta.es/jda</shorturl>
<longurl>http://juntadeandalucia.es/index.html</longurl>
<message>success</message>
<statusCode>200</statusCode>
</result>
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
6.3
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 21 de 24
Entrada en vigor: 01/11/12
Obtener las estadísticas de una URL corta
Esta llamada obtendrá las estadísticas de la URL corta que se le pasa como parámetro. Los parámetros que utiliza
esta llamada al API son:
– action: url-stats. Se indica que la acción a realizar es obtener las estadísticas de la URL corta que se indica.
– shorturl: URL corta de la cual se quiere obtener sus estadísticas.
– format: es un parámetro opcional que indica el formato de la respuesta devuelto por el API. Puede ser: "jsonp",
"json" o "xml".
Ejemplo de llamada:
– http://lajunta.es/yourls-api.php?action=url-stats&shorturl=jda&format=xml
Esta llamada indica al API que se quiere obtener las estadísticas de la URL corta “jda” y que devuelva el resultado de
la operación en formato xml. El resultado sería el siguiente:
<?xml version="1.0" encoding="iso-8859-1"?>
<result>
<statusCode>200</statusCode>
<message>success</message>
<link>
<shorturl>http://lajunta.es/jda</shorturl>
<url>http://juntadeandalucia.es/index.html</url>
<title><![CDATA[Junta de Andaluc&Atilde;&shy;a]]></title>
<timestamp>2014-03-04 12:38:18</timestamp>
<ip>10.240.205.73</ip>
<clicks>1</clicks>
</link>
</result>
6.4
Obtener las estadísticas de todas las URLs
Esta llamada obtendrá las estadísticas de todas las URLs del sistema. Los parámetros que utiliza esta llamada al API
son:
–
–
–
–
–
action: stats. Se indica que la acción a realizar es obtener las estadísticas de todas las URLs del sistema.
filter: los valores que puede tomar son: “top”,”bottom”,”rand” y “last”. El significado de cada valor es el
siguiente:
– 'top': ordenación por nº de clicks de forma descendente.
– 'bottom': ordenación por nº de clicks de forma ascendente.
– 'last': ordenación por fecha en forma descendente.
– 'rand': ordenación aleatoria.
limit: nº de links a devolver. Por defecto 10.
format: es un parámetro opcional que indica el formato de la respuesta devuelto por el API. Puede ser: "jsonp",
"json" o "xml".
Ejemplo de llamada:
http://lajunta.es/yourls-api.php?action=stats&filter=top&limit=10&format=xml
<?xml version="1.0" encoding="iso-8859-1"?>
<result>
<links>
<link_1>
<shorturl>http://lajunta.es/v</shorturl>
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 22 de 24
Entrada en vigor: 01/11/12
<url>http://lajunta.es/admin/index.php</url>
<title></title>
<timestamp>2014-03-04 12:40:13</timestamp>
<ip>10.240.205.73</ip>
<clicks>1</clicks>
</link_1>
<link_2>
<shorturl>http://lajunta.es/jda</shorturl>
<url>http://juntadeandalucia.es/index.html</url>
<title><![CDATA[Junta de Andaluc&Atilde;&shy;a]]></title>
<timestamp>2014-03-04 12:38:18</timestamp>
<ip>10.240.205.73</ip>
<clicks>1</clicks>
</link_2>
<link_3>
<shorturl>http://lajunta.es/goo1</shorturl>
<url>http://www.google.com</url>
<title>Google</title>
<timestamp>2014-03-04 10:47:13</timestamp>
<ip>10.240.205.73</ip>
<clicks>1</clicks>
</link_3>
…...
</links>
<stats>
<total_links>8</total_links>
<total_clicks>3</total_clicks>
</stats>
<statusCode>200</statusCode>
<message>success</message>
</result>
6.5
Obtener el número total de URLs y el conteo de ellas
Esta llamada obtendrá el número total de URLs en el sistema y el número de clicks de cada una de ellas. Los
parámetros que utiliza esta llamada al API son:
– action: db-stats. Se indica que la acción a realizar es obtener el número total de URLs del sistema y sus clicks.
– format: es un parámetro opcional que indica el formato de la respuesta devuelto por el API. Puede ser: "jsonp",
"json" o "xml".
Ejemplo de llamada:
– http://lajunta.es/yourls-api.php?action=db-stats&format=xml
<?xml version="1.0" encoding="iso-8859-1"?>
<result>
<db-stats>
<total_links>8</total_links>
<total_clicks>3</total_clicks>
</db-stats>
<statusCode>200</statusCode>
<message>success</message>
</result>
7
RSS
Para acceder al Rss que provee el servicio se deberá acceder a la siguiente URL:
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 23 de 24
Entrada en vigor: 01/11/12
– http://lajunta.es/rss-1.1.php
Esta funcionalidad devuelve un Rss con los últimos 20 items que hay almacenados en el sistema.
Ejemplo de resultado devuelto:
<?xml version="1.0" encoding="UTF-8" ?>
<rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>Latest links on http://lajunta.es</title>
<link>http://lajunta.es</link>
<description>Latest links on http://lajunta.es</description>
<atom:link href="http://lajunta.es/rss.php" rel="self" type="application/rss+xml" />
<generator>YOURLS v1.5.1</generator>
<language>en</language>
<item>
<title>Terra España - Noticias, Deportes, Entretenimiento y Estilo de Vida</title>
<description>http://www.terra.es</description>
<pubDate>Thu, 20 Sep 2012 13:39:22 +0200</pubDate>
<link>http://lajunta.es/ejx9f</link>
<guid isPermaLink="false">http://lajunta.es/ejx9f</guid>
</item>
<item>
<title>Google</title>
<description>http://www.google.com</description>
<pubDate>Tue, 18 Sep 2012 13:03:31 +0200</pubDate>
<link>http://lajunta.es/goo</link>
<guid isPermaLink="false">http://lajunta.es/goo</guid>
</item>
<item>
<title>YOURLS: Your Own URL Shortener</title>
<description>http://yourls.org/</description>
<pubDate>Fri, 14 Sep 2012 13:26:06 +0200</pubDate>
<link>http://lajunta.es/yourls</link>
<guid isPermaLink="false">http://lajunta.es/yourls</guid>
</item>
</channel>
</rss>
8
GESTIÓN DEL DICCIONARIO DE PALABRAS PROHIBIDAS.
Para acceder al diccionario de palabras prohibidas se deberá acceder al fichero de configuración de Yourls en
sitio_base_yourls/user/config.php.
Dentro de este fichero de configuración se encuentra un apartado donde se define un listado de palabras que no se
quiere que aparezcan como identificadores de URLs cortas:
$yourls_reserved_URL = array(
'porn', 'faggot', 'sex', 'nigger', 'fuck', 'cunt', 'dick', 'gay'
);
Para incluir una nueva palabra dentro de este listado solamente se deberá seguir la secuencia indicada (coma y la
palabra a prohibir entre comillas simples) y salvar el fichero. No será necesario reiniciar el servicio para que los cambios surtan
efecto.
Si por ejemplo se añade la nueva palabra “agua” a este listado:
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red
MANUAL DE USUARIO ADMINISTRADOR - ACORTADOR DE URLS
Departamento /Área/Unidad: Ingenieria y C. Calidad/ Servicios Telemáticos
Tipo de documento: Manual
Cód. SDS-DV-43-NA1A2120918-1
Edición. 3
Fecha: 02/06/14
Pág. 24 de 24
Entrada en vigor: 01/11/12
$yourls_reserved_URL = array(
'porn', 'faggot', 'sex', 'nigger', 'fuck', 'cunt', 'dick', 'gay', 'qwert'
);
Cuando se intente utilizar este identificador para una nueva URL aparecerá una pantalla como la siguiente:
 2014 Sociedad Andaluza para el Desarrollo de las Telecomunicaciones.
Este documento no tiene garantía de estar en vigor. Consulte el fichero emplazado en red

Documentos relacionados