Inspection Ownership
Para un mejor control de alcances y permisos, cada inspección tiene una relación con una compañía y un usuario miembro de dicha entidad
Al momento de crear una inspección via API, uno puede indicar que miembro de la compañía sera dueño de dicha inspección
Vincular la inspección con un usuario trae ciertos beneficios:
- Listar, ver el detalle de inspección, descargar reportes e imágenes
- Alcance y control sobre que inspecciones los usuarios pueden tener acceso
Vincular usuario en una inspección
Al momento de la solicitud de creación de inspección uno puede pasar el parámetro producer.internalId
Internal ID
Este parámetro representa el identificador único que se le fue asignado de manera manual al usuario en el momento de la invitación para formar parte de la compañía
Fue creado con el fin de dar la posibilidad a la empresa de guardar un identificador de usuario propio de su sistema dentro de Autoinspector para facilitar luego la relación de sus usuarios con los recursos que se crean dentro de Autoinspector.
Captura del Dashboard sobre el primer paso del onboarding de invitación de usuarios a la compañía
Ejemplo de creación con internal id
Vamos a ponernos en el papel de una compañía que quiere automatizar la creación de la inspección, por lo que necesitaran realizar la implementación via api en su sistema
Esta compañía cuenta con su aplicación web. Dentro de esta plataforma, existen usuarios que generan el evento de creación de inspección
Ademas, la empresa quiere que los usuarios de su plataforma puedan usar el Dashboard de Autoinspector para poder ver el detalle de inspección, descargar reportes e imágenes y demás beneficios que el Dashboard proporciona
Los usuarios dentro de la plataforma de la empresa cuentan con un identificador único que es de tipo entero autoincremental
1. Invitación de usuarios
El primero paso que esta compañía deberá seguir es el de invitar a los usuarios que forman parte de su plataforma actual para que formen parte de Autoinspector.
Para cumplir con este objetivo, deberán invitar multiples usuarios ingresando su correo electrónico y el identificador único del usuario dentro del sistema de la empresa (ID. interno)
Los usuarios tendrán los permisos necesarios para crear y listar sus inspecciones
Luego de que la invitación fue realizada, los usuarios deberán registrarse dentro de Autoinspector con la invitación que les llego en su correo
2. Creación de inspección
Una vez que los usuarios ya se registraron con la invitación que se les realizo, ya estarían formando parte de la compañía dentro de Autoinspector
Esto nos da lugar a poder crear inspecciones y vincularla con un usuario pasando el internal id que se le asigno anteriormente
La ventaja principal de esto es que no debemos pasar ningún identificador propio de Autoinspector para vincular una inspección con un usuario que interactúa con una plataforma externa
Si el internalId
proporcionado no matchea con ningún usuario, la inspección se creara de todas formas
Si deseas que Autoinspector retorne un error en caso de no matchear con un usuario, puedes enviar el parámetro producer.mustMatchUser
en true
curl -X POST 'https://api.autoinspector.ai/v1/inspection/car' \
-H 'x-api-key: <YOUR_API_KEY_GOES_HERE>' \
-H 'Content-Type: application/json' \
-d '{
...
"producer": {
"internalId": "1"
},
...
}'
3. Detalle de inspección
Una vez que la inspección ya fue creada y vinculada con usuario, dicho usuario podrá ingresar al Dashboard con sus credenciales y empezar a disfrutar de todas las features que el Dashboard proporciona