Gestionar usuarios API

Uno de los objetivos de Actito es ofrecerte una gran conectividad en tu enfoque de marketing. Por eso ponemos especial cuidado en hacer posible el intercambio de datos entre Actito y otros sistemas propios de tus actividades.

Las API públicas a tu disposición te permitirá interactuar con Actito sin tener que pasar por la interfaz.

Las API requieren una cuenta de usuario específica, distinta de la cuenta de acceso normal a la plataforma.

El administrador de tu licencia puede crear directamente desde la aplicación "usuarios API" en la plataforma de configuración de la licencia

images/download/thumbnails/636485801/image2022-2-23_15-25-26.png

Crear un usuario API

En la pantalla de inicio de la aplicación aparecerán todos los usuarios existentes.

Para añadir un nuevo usuario haz clic en + Crear usuario API.

images/download/attachments/636485801/image2022-3-10_12-45-16.png

A continuación debes completar los datos del usuario API:

  • Nombre y apellidos

  • Dirección de correo electrónico

  • Número de teléfono móvil

  • Idioma y género

  • Parámetros de entidad

  • Derechos de acceso personalizados

images/download/attachments/636485801/image2022-7-7_13-0-1.png

Gestión de los derechos de acceso personalizados

Al igual que los derechos de acceso a la plataforma están definidos por las configuraciones de los usuarios, es posible restringir las llamadas que puede realizar un usuario de la API.

El administrador de los usuarios de la API de una licencia puede definir los derechos para cada usuario (Sin acceso/Lectura y Escritura) para diferentes operaciones agrupadas en 4 categorías.

Los derechos pueden editarse haciendo clic en el botón "Editar".

images/download/attachments/636485801/image2022-7-7_13-0-57.png

En la plataforma, el administrador puede definir los accesos por módulo y por nivel. Para ello, tiene que seleccionar el nivel de acceso que quiere dar al usuario a los diferentes módulos que pertenecen a diferentes grupos (detallados más adelante). Una vez seleccionados los accesos, haga clic en "Guardar" para guardar la selección.

Hay 3 niveles de acceso diferentes:

  1. Sin acceso: el usuario no podrá realizar ninguna llamada en este módulo

  2. Lectura: desde un punto de vista técnico, el usuario sólo podrá realizar llamadas con el método GET en este módulo

  3. Lectura y Escritura: desde el punto de vista técnico, el usuario podrá realizar llamadas con todos los métodos implementados en este módulo (GET, POST, PUT, PATCH, DELETE,...)

A continuación, hay 4 grupos diferentes estructurados en módulos :

Estructura de datos

Este grupo se utiliza para gestionar la estructura de las tablas de perfiles y las tablas personalizadas.

Intercambio de datos

Este grupo incluye intercambios de datos como importaciones de datos, transferencias de archivos y sincronizaciones ETL, gestión de perfiles y datos personalizados, webhooks, objetivos y formularios.

Activación del perfil

Este grupo incluye acciones para activar los perfiles a través de canales de comunicación como campañas de sms, correo electrónico, bibliotecas de contenido HTML externas, correos transaccionales, escenarios y archivos de objetivos sincronizados.

Configuración de Actito

Este grupo contiene las tareas y acciones personalizadas para integrar Actito con sistemas externos.

images/download/attachments/636485801/image2022-7-7_13-1-57.png

Para obtener los detalles de la categoría de cada llamada a la API existente, descargue el siguiente archivo: taxonomía-api-derechos.xlsx. Muestra la taxonomía de estas diferentes categorías con los módulos asociados, la posibilidad o no de definir un derecho de acceso, las agrupaciones de operaciones según la estructura de la documentación para desarrolladores, la URL de la documentación relacionada con cada llamada y el alcance (Lectura/Escritura):

En el portal para desarrolladores también se especifican los derechos necesarios en cada llamada.

images/download/attachments/636485801/image2022-7-7_13-3-8.png

Tip

Cuando se habla de acceso de escritura en los derechos de la API de Actito, siempre implica el módulo más alto, que da acceso tanto de lectura como de escritura a la información. No existe un nivel de acceso de sólo escritura y no de lectura.

Gestión de los usuarios existentes

Una vez hayas creado el usuario, puedes acceder a sus datos de contacto a través del botón Ver, y modificarlos a través del botón Editar.

images/download/attachments/636485801/image2022-3-10_12-47-26.png

Ver la clave API

La autenticación generada por la aplicación Gestionar usuarios API es a través del sistema de clave API, que ofrece mayor seguridad y autonomía que el acceso que anteriormente generaba el equipo de soporte Actito con un autenticación básica.

La autenticación mediante clave API te da acceso directo a su gestión y permite no tener que depender de una contraseña, puesto que el proceso de reiniciarla podría tener consecuencias para las integraciones que ya hayas puesto en marcha.

Nota

Todos los accesos API con autenticación básica seguirán funcionando. No obstante, todo los usuarios API nuevos deberán crearse con autenticación por clave API.

Para ver el identificador de una cuenta, haz clic en Ver clave API.

images/download/attachments/636485801/image2022-3-10_12-48-13.png

La clave API es una cadena de caracteres que podrás utilizar para conectarte a la API. El botón a la derecha te permite copiarla directamente para compartirla.

images/download/attachments/636485801/image2022-3-10_12-49-47.png

Asegurar la clave

Las claves API de tu licencia estarán disponibles solo a través de la aplicación Gestionar usuarios API. Esta aplicación está vinculada a la configuración de permisos AdminUser.

Esto significa que solo el administrador de la licencia tiene control sobre los usuarios API, que suelen ser miembros del equipo interno o proveedores externos. La información solicitada para la creación de una cuenta incluye la dirección de correo electrónico y el número de teléfono móvil para que el administrador de la licencia pueda transmitir la clave por el canal seguro de su elección.

Una clave API es suficiente para conectarse y no está vinculada a una contraseña. De este modo no hay riesgo de que se pierda el identificador, porque estará almacenado siempre en la aplicación Gestionar usuarios API.

No obstante, hay varios métodos para bloquear el acceso de una clave API.

Reiniciar la clave

Reiniciar la clave te permite interrumpir su acceso en caso de que esta ya no sea segura. El efecto que tendrá esta acción será desconectar todas las llamadas existentes. Al instante se generará una nueva clave segura que te permitirá volver a configurar las llamada que desees mantener.

Revocar la clave

Revocar una clave supone eliminarla y ya no será posible utilizarla, tampoco para las llamadas existentes.

No será posible recuperar dicha clave.

Desactivar un usuario desde el menú principal tiene el mismo efecto. El usuario aparecerá entonces en la pestaña de usuarios desactivados. En caso de volver a ser activado, habría que reiniciar la clave del usuario.

images/download/attachments/636485801/image2022-3-10_12-51-13.png

Eliminar un usuario

También es posible eliminar completamente un usuario a través de los botones Más y Eliminar.

images/download/attachments/636485801/image2022-3-10_12-51-38.png

Atención

Tanto reiniciar, como revocar y eliminar una clave conllevan la desconexión de todas las llamadas que se hayan establecido con dicha clave.

Utilizar la clave API

A la hora de configurar solicitudes a una API, la clave no se utiliza directamente como identificador.

La clave sirve para generar un token de acceso de validez limitada (15 minutos), que habrá que proporcionar 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 «Autenticación».

GET Token
curl
-X GET 'https://apitest.actito.com/auth/token' \
-H 'Authorization: qhdfbvdh747R49FRHrthqhdfbvdh74' \
-H 'Accept: application/json'

El token generado servirá para la autenticación de todas las llamadas durante los siguientes 15 minutos. Figurará como «Authorization» de tipo «Bearer» en todas las llamadas.

Exemple Bearer Token
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'

Nota

Para más información sobre las URL utilizadas para generar el token en los diferentes entornos, así como sobre la autenticación en general, tu equipo de TI puede consultar la página al respecto de nuestra documentación técnica.

La autenticación por clave API es compatible con las versiones 4 y 5 de nuestra API pública.

Restringir la dirección IP

Para mayor seguridad, tienes la posibilidad de asociar la clave API a una dirección IP específica (o un rango de IP).

Activa los "Parámetros avanzados" al crear un nuevo usuario de API o edita uno existente para restringir el uso de la clave a una IP específica.

images/download/attachments/636485801/image2021-8-6_9-57-9.png

Si se intercepta una solicitud de API de una IP no autorizada, se rechazará y se enviará una advertencia a la dirección de correo electrónico asociada con la clave.

La restricción puede definirse como una dirección IP simple o como una dirección CIDR (subred).

En este último caso, el rango debe proporcionarse con el formato IP + CIDR.

Por ejemplo, para poner una restricción en la IP 192.168.1.1 con una máscara de subred de 255.255.255.248, el valor que debería proporcionarse en la restricción sería 192.168.1.1/29

CIDR - Tabla de correlación de subredes

CIDR

Bits disponibles

Máscara de subred

Número de hosts por subred

/1

31

128.0.0.0

2^31^-2 = 2 147 483 646

/2

30

192.0.0.0

2^30^-2 = 1 073 741 822

/3

29

224.0.0.0

2^29^-2 = 536 870 910

/4

28

240.0.0.0

2^28^-2 = 268 435 454

/5

27

248.0.0.0

2^27^-2 = 134 217 726

/6

26

252.0.0.0

2^26^-2 = 67 108 862

/7

25

254.0.0.0

2^25^-2 = 33 554 430

/8

24

255.0.0.0

2^24^-2 = 16 777 214

/9

23

255.128.0.0

2^23^-2 = 8 388 606

/10

22

255.192.0.0

2^22^-2 = 4 194 302

/11

21

255.224.0.0

2^21^-2 = 2 097 150

/12

20

255.240.0.0

2^20^-2 = 1 048 574

/13

19

255.248.0.0

2^19^-2 = 524 286

/14

18

255.252.0.0

2^18^-2 = 262 142

/15

17

255.254.0.0

2^17^-2 = 131 070

/16

16

255.255.0.0

2^16^-2 = 65 534

/17

15

255.255.128.0

2^15^-2 = 32 766

/18

14

255.255.192.0

2^14^-2 = 16 382

/19

13

255.255.224.0

2^13^-2 = 8 190

/20

12

255.255.240.0

2^12^-2 = 4 094

/21

11

255.255.248.0

2^11^-2 = 2 046

/22

10

255.255.252.0

2^10^-2 = 1 022

/23

9

255.255.254.0

2^9^-2 = 510

/24

8

255.255.255.0

2^8^-2 = 254

/25

7

255.255.255.128

2^7^-2 = 126

/26

6

255.255.255.192

2^6^-2 = 62

/27

5

255.255.255.224

2^5^-2 = 30

/28

4

255.255.255.240

2^4^-2 = 14

/29

3

255.255.255.248

2^3^-2 = 6

/30

2

255.255.255.252

2^2^-2 = 2

/31

1

255.255.255.254

2^1^-0 =2

/32

0

255.255.255.255

2^0^-0 =1

Tip

Ten en cuenta que una restricción de IP es ideal para restringir el acceso solo desde sus máquinas con una IP fija, pero no tanto si la clave se usará para pruebas / implementación manuales por parte de usuarios humanos con IP dinámicas.