Utilizar los servicios web

Actito permite interactuar con sus datos a través de una API de tipo REST, que permite llevar a cabo diversas operaciones de creación, modificación y supresión.

La presente página te muestra el funcionamiento y los límites de la API.

Métodos utilizados en los servicios web

Las operaciones disponibles desde los servicios web Actito se agrupan en cuatro métodos que tienen sus propias funcionalidades: GET, PUT, POST y DELETE.

images/download/attachments/634355828/image2019-3-13_14-37-1.png

El método GET

Este método recupera una representación del recurso solicitado. Se trata de un método solo de lectura, es decir, que al aplicarlo sobre un recurso el resultado nunca será una modificación del recurso. Es, por tanto, un método seguro.

Permite, principalmente, extraer información de Actito, ya sea para procesarla a través de tus otros sistemas (perfiles, campañas, etc.) o para obtener información estructural que facilite la definición de los otros métodos (obtener la estructura de una base de datos,...).

El método POST

Permite crear un recurso dentro de una colección de recursos utilizando los datos introducidos en el cuerpo de la solicitud.

Se utiliza principalmente para crear nuevos elementos, pero puede utilizarse también para modificaciones y actualizaciones.

El método PUT

Este método permite remplazar la representación de un recurso utilizando los datos introducidos en el cuerpo de la solicitud, o bien, crear un nuevo recurso si todavía no existe.

Se utiliza principalmente para actualizar elementos, pero su comportamiento implica que también pueda utilizarse para crearlos.

El método DELETE

Este método elimina todas las representaciones de un recurso.

Puede tratarse de la eliminación de un elemento concreto (cancelar la subscripción de un perfil) o un elemento más general (eliminar un perfil o el borrador de un correo electrónico).

Formato de los servicios web

Las API de Actito son compatibles con los formatos JSON y XML. No obstante, hace tiempo que XML quedó obsoleto. Las nuevas llamadas a servicios web disponibles, o las actualizaciones de las llamadas existentes, ya no están disponibles en XML. Todos los ejemplos utilizados en este capítulo serán por tanto ejemplos del formato JSON. Las API existentes seguirán siendo, hasta nuevo aviso, compatibles con XML.

Te recomendamos encarecidamente optar por el formato JSON. Si no conoces tan bien ese formato, puedes validar tu código con la ayuda de la página web https://jsonlint.com/.

Durante la creación o modificación remota de un elemento, será necesario especificar el formato de respuesta esperado. En la documentación técnica con la que podrás crear la solicitud, podrás escoger entre XML y JSON en el menú desplegable del campo «Response Content Type».

images/download/attachments/634355828/image2019-3-13_11-22-6.png

Utilización óptima de los servicios web

Para garantizar un uso óptimo de los servicios web se han establecido una serie de limitaciones de uso:

  • Número máximo de usuarios de servicio web por licencia: 5

  • Número máximo de solicitudes por minuto: 60

  • Número máximo de solicitudes masivas por día: 12

  • Número máximo de solicitudes simultáneas por licencia: 5

  • Tamaño máximo del archivo comprimido para una solicitud masiva: 100 MB

Sobrepasar estas limitaciones producirá un error o una ralentización del rendimiento.