API multinivel

La API de IvozProvider está dividida en los mismos tres niveles que el portal de administración web más la API de usuario:

  • God

  • Marca

  • Cliente

  • Usuario

Esta división permite que diferentes roles con diferentes responsabilidades se integren sin comprometer la seguridad (leer, editar, actualizar o eliminar los datos que no deberían).

Si revisas las políticas de seguridad (atributos read_access_control y write_access_control), verás que aplicamos filtros de lectura y validaciones de escritura basadas en la información del usuario (token). Un enfoque de API único requeriría validaciones complejas más propensas a fallos, introducir errores y requerir consultas enormes que afectarían el rendimiento.

Nota

Es por eso que lo dividimos en tres APIs con mecanismo de suplantación para moverse entre ellas. Este mecanismo se explica en la sección Caso de Uso.

Para acceder a cada nivel, necesitarás una URL y credenciales correspondientes al nivel:

Acceso a la API God

Acceso a la API de Marca

Acceso a la API de Cliente

Acceso a la API de Usuario

  • Credenciales: Credenciales de Usuario definidas en Usuarios.

Advertencia

Todos los nombres de usuario de las credenciales son únicos a nivel de marca. Es por eso que se necesita el dúo nombre de usuario + URL de la marca para identificar a un usuario (tanto en la API como en el portal web).

Truco

Como tanto las URLs de marca como de cliente están vinculadas internamente a la misma marca (cliente dentro de esa marca), también es posible acceder a la API de cliente usando una URL de marca + /api/client.