Helpcenter - Helice logo

API Desarrollo

Este área, a la que podremos acceder desde Menú lateral > Configruar > API Desarrollo, contiene información destinada a usuarios más avanzados, que entiendan de programación, será muy útil para automatizar acciones desde softwares externos.

Los servicios web permiten integrar acciones en otras herramientas software, de forma que usando un protocolo REST puedes realizar determinadas acciones sobre tu proyecto. De este modo, se podrán programar acciones básicas sobre los usuarios, o sobre el contenido del proyecto.


Para poder llevar a cabo estas acciones es necesario tener en cuenta dos parámetros únicos por cada proyecto:

- APP ID, es el identificador único de tu proyecto, puedes ver cuál es en tu panel de servicios web.

- Token del proyecto (Clave privada), este token es la clave privada de tu proyecto, la única forma de proteger los servicios web de tu proyecto, para que no puedan hacer uso del mismo, ningún usuario que no haya sido autorizado para ello previamente. 

image


SERVICIOS WEB DISPONIBLES

Cada uno de estos servicios cuenta con una serie de parámetros además de del APP ID y el token, que veíamos anteriormente.

Al hacer click sobre cada servicio, se desplegarán todos los detalles a tener en cuenta para su configuración: Endpoint, Protocolo, Parámetros de entrada y Códigos de respuesta.

Los distintos parámetros de entrada, irán acompañados de una pequeña anotación que indicará de manera individual su grado de obligatoriedad, en caso de que alguno de los obligatorios no se agreguen a la llamada del servicio web, este dará un mensaje de error.

Los parámetros opcionales podrán ser incluidos o no, en función de la acción que se quiera realizar.

Cada uno de los servicios, además también cuenta con mensajes de error y éxito, llamados códigos de respuesta, que revelan si la llamada al servicio web se ha realizado con éxito o no, y en este último caso, saber qué ha sucedido.


Estos servicios están categorizados en dos bloques:

1. A nivel Usuario

- Creación de nueva cuenta de usuario.

- Edición de información de cuenta de usuario.

- Actualización de credenciales de acceso de cuenta de usuario.

- Activación / Inactivación / Eliminación / Cierre de cuenta de usuario.

- Adición / Reemplazo / Desvinculación de todos los roles de cuenta de usuario.

- Añadir un nuevo elemento a una sección.

- Añadir un nuevo evento a una sección de tipo Agenda.

- Registro de usuario si no existe y auto autenticación.


2. A nivel Contenido

- Añadir un nuevo elemento a una sección.

- Añadir un nuevo evento a un módulo de tipo Agenda.

- Obtener la valoración media de un elemento (valor decimal comprendido entre 0 y 10).

- Añadir una votación a una encuesta.

- Exportar opciones de un elemento excel.

- Obtener la fecha de la última noticia publicada en un módulo de tipo Blog / Noticias.