Servicios web
El objetivo de Actito es ofrecerte una amplia variedad de opciones de conectividad para tu marketing. Es por ello que ponemos especial cuidado en hacer posible el intercambio de datos entre Actito y otros sistemas propios de tus actividades.
Las API públicas disponibles te permiten interactuar directamente con Actito sin tener que hacerlo a través de nuestra interfaz. Gracias a los servicios web, podrás hacer una solicitud de datos almacenados en Actito y recuperarlos como respuesta. También podrás programar el envío a Actito de los datos de tu sistema.
Más que un simple procedimiento de intercambio de datos, los servicios web de Actito te permiten activar también la utilización de dichos datos y automatizar su tratamiento.
Aceso a las API públicas
Actito permite el acceso a los servicios web en dos entornos distintos: TEST y PROD.
En nuestro portal para desarrolladores contamos con documentación técnica en inglés al respecto. La actualizamos constantemente.
Creación de una cuenta de usuario de servicios web y autenticación
El uso de las API requiere autenticación. Se trata de cuentas específicas separadas de las cuentas de usuario habituales de la plataforma.
Actualmente coexisten dos sistemas de autenticación:
-
Autenticación básica (HTTP basic authentication)
-
Autenticación mediante clave API (API key)
Autenticación básica
La autenticación básica se lleva a cabo a través de una cuenta Web service y una contraseña. Esta cuenta específica es fácilmente distinguible de tu cuenta normal de acceso a Actito porque siempre incluirá la mención «webservices» o «WS». Tu ASM o el equipo de soporte serán los encargados de comunicártela.
A la hora de conectarte, el nombre de usuario será el nombre de la licencia seguido de la cuenta Web service, con el formato licencia/cuentaWS.
A continuación, las credenciales deben codificarse en base64 y respetando el siguiente formato «nombreUsuario:contraseña».
Por ejemplo, para la licencia «ActitoIODemo», con la cuenta Web service «WebServices_test» y la contraseña «NBCJD44DLFNX», la entidad «Authorization» de tu llamada será:
Basic base64(“ActitoIODemo/WebServices_test:NBCJD44DLFNX$”)
o directamente codificado en base64:
Basic QWN0aXRvSU9EZW1vL1dlYlNlcnZpY2VzX3Rlc3Q6TkJDSkQ0NERMRk5YJA==
La autenticación básica solo es compatible con la versión 4 (véase la siguiente sección) de nuestra API. Por tanto, quedará obsoleta en el futuro. Las cuentas con este tipo de autenticación siguen siendo completamente funcionales, pero no se puede crear nuevos usuarios con este método. Te recomendamos utilizar claves API.
Recuerda
Todavía pueden crearse nuevos accesos con autenticación básica para ciertos conectores que requieren, obligatoriamente, este tipo de autenticación, como es el caso de nuestra integración con Zapier.
Autenticación mediante clave API
Se trata del nuevo protocolo utilizado para conectarse a las API de Actito. Permite acceder tanto a la V4 como a la V5. El administrador de la licencia es quien tiene la opción de gestionar directamente las claves API (véase Gestionar usuarios API).
A la hora de configurar una llamada API, la clave API no se utiliza directamente como credencial.
Sirve para generar un token de acceso de validez limitada (15 minutos) que debe incluirse en todas las llamadas.
Por ejemplo, para generar un token en el entorno TEST, la llamada será
GET https://apitest.actito.com/auth/token
con la clave API en la entidad «Authorization».
curl -X GET 'https://apitest.actito.com/auth/token' \
-H 'Authorization: qhdfbvdh747R49FRHrthqhdfbvdh74' \
-H 'Accept: application/json'
Así obtendrás un token («accesToken» en la respuesta).
{ "accessToken": "AAAAAAAAAAAAAAAAAAAAAMLheAAAAAAA0%2BuSeid%2BULvsea4JtiGRiSDSJSI%3DEUifiRBkKG5E2XzMDjRfl76ZC9Ub0wnz4XsNiRVBChTYbJcE3F",
"tokenType": "bearer",
"expiresIn": "900s",
"scope": "read write",
"jti": "ce6c1d3c-ab49-4b62-8f4c-964351ac5d58"
}El token servirá para la autenticación de todas las llamadas durante los siguientes 15 minutos. En todas ellas deberá introducirse como «Authorization» de tipo «Bearer».
curl -X GET 'https://apitest.actito.com/v5/entities/MyEntity/etls' \
-H "Authorization: Bearer
eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiI0IiwiaWF0IjoxNTg2ODY1MjE1LCJpc3MiOiJhY3RpdG8iLCJleHAiOjE1ODY4NjYxMTUsImxpY2VuY2VJZCI6MTI3NDAsImFjY291bnRJZCI6MTIsInBvbCI6Im1haW5Qb2xpY3lBcGkiLCJzdWIiOiI2ZWY3YjZmYS0wYTc1LTQ1YTYtYmE5My1iZGY5MmUyZjg3NDAifQ.umizXm0TueN6jRkMCaz9AnQP30qNxud5XIxnZiPzz24L8Aon7WKeJ8_49xcjsTe_v13nv4AI9991Mw_k9bvQffT__eikkv9UMmZ22wvQr5UxCH5Y-NkxFRctEGLjmkEdFFe2EuOkF1GjsIetPrJgY-_L6bpoa3G0o69IWavBIFowQtw_q0FOPaZ_JtBLiDiFH59IM5s4-8S-QAhGkGgjOhTzqBTyDBGj8cqnhvr9eFwgoxGSAZ1QLGU5yTRyIJm8Uaq97M5UhKn98ixK4oQhQvVKwW9MDgGyf0jLFLEFO7l9kyFON34OsxiTyK58U_OFJzehgxqRokBE3wXWo9rKEA" \
-H 'Accept: application/json'
Versión de las API públicas
Actito mejora sus productos constantemente y trabaja de forma activa para ampliar su plataforma de integraciones.
Esta es la razón por la que hemos lanzado la V5 de nuestras API públicas, cuyo objetivo es estandarizar y garantizar la coherencia entre los distintos recursos. Todas las novedades de la API de Actito se desarrollarán exclusivamente en V5.
Pero esto no quiere decir, ni mucho menos, que la V4 esté obsoleta. Las dos versiones coexisten y la V4 quedará obsoleta solo de forma progresiva. Nunca abandonaríamos una versión sin avisarte con la anterioridad suficiente para que puedas migrar tu código a la versión nueva.
Versión 4
Las rutas V4 son accesibles tanto con autenticación básica como con autenticación por clave API. En la plataforma de desarrolladores son V4 todas las rutas en las que no se diga explícitamente que son V5. Todas las llamadas de la presente documentación son V4.
Para conectarse mediante «Basic Auth»:
https://${env}.actito.com/ActitoWebServices/ws/v4
Para conectarse mediante clave API:
https://${env}.actito.com/v4
En la plataforma de desarrolladores podrás conocer el valor de la variable ${env} según el entorno en el que te encuentres de modo que puedas obtener la URL completa.
Recuerda
En «Basic Auth» la URL https://www.actito.be/ActitoWebServices/ws/v4 sigue estando disponible.
Versión 5
Las rutas V5 solo son accesibles mediante autenticación por clave API. Todas las rutas V5 están explícitamente indicadas como tales. Se trata de las últimas adiciones a la librería API de Actito. Son rutas que no se explican en la presente documentación, sino que solo se explican en la plataforma de desarrolladores.
Para conectarse a la V5:
https://${env}.actito.com/v5
En la plataforma de desarrolladores podrás conocer el valor de la variable ${env} según el entorno en el que te encuentres de modo que puedas obtener la URL completa.
Recuerda
Mediante la clave API, la llamada para obtener un token es la misma tanto para la V4 como para la V5. Se tratará siempre de GET https://${env}.actito.com/auth/token
Nota
En la plataforma de desarrolladores, cada llamada puede testarse directamente a través de un formulario al final de la página. Se puede configurar una variable {env.domain} para guardar en la memoria tu versión y tu modo de autenticación, como se explica al final de esta página.
Conceptos Actito disponibles a través de servicios web
Todas las operaciones se reagrupan bajo un concepto que corresponde a la categoría de recursos Actito a la que se aplicarán.
Cada uno de estos conceptos puede usar uno o varios métodos, según su naturaleza y según las operaciones disponibles.
Para familiarizarte con los distintos conceptos con los que puedes interactuar a través de la API Actito, te recomendamos leer el capítulo dedicado a los conceptos Actito accesibles a través de un web service.