Servicios iClavis

En este manual, se explicará cómo utilizar los servicios de iClavis con el fin de hacer una conexión a un portal externo de propietarios o consumir la información de manera masiva para cualquier fin interno de la empresa.

General

1. Ingresar al swagger de la API GCI: https://api-gci-rest.integracionplanok.io/docs/#/

2. En el menú “Guía” se encuentran todos los servicios de iClavis:

   

¿Cómo consumir los servicios?

1. Utilizar el servicio “POST /guia/login”. Ingresar un email y contraseña de un propietario real:

   

2. Este servicio entregara un token de acceso para poder consumir los demás servicios:

   

3. Copiar y pegar este token en el header donde dice “Api key authorization”:

   

4. Luego utilizar el servicio GET /guia/inmobiliarias-proyectos-usuario/api-key/{rutDNI}. Ingresar el rut del propietario real sin digito verificador y su apikey de inmobiliaria (si no sabe cual es su api key, contacte a la mesa de ayuda de PlanOK o a su ejecutiva):

   

5. Este servicio nos entregará todos los proyectos en los que el propietario tiene al menos un negocio promesado. Es importante guardar el id del proyecto, ya que será requerido en otros servicios:

   

6. Ahora teniendo el rut del propietario, id del proyecto y su apikey de cliente, ya puede consumir todos los demás servicios para extraer información. Los que utiliza iClavis son:

   • GET/guia/datos-propiedad

   • GET/guia/datos-forma-pago

   • GET/guia/agenda-contacto

   • GET/guia/tipo-consultas

   • GET/guia/historial-consulta

   • GET/guia/historial-notificaciones-push

   • GET/guia/archivos/documentos

   • GET/guia/archivos/fotos

   • GET/guia/archivos/videos

¿Cómo registrar a un propietario?

1. Utilizar el servicio POST/guia/registrar-propietario-pivote para registrar inicialmente al propietario en la BD de propietarios:

   

2. Luego utilizar el servicio POST/guia/registro-inicial-propietario. Ingresar el rut sin dígito verificador del propietario para registrarlo inicialmente en cognito:

   

3. Con lo anterior, ya tenemos al propietario creado en cognito, ahora falta cambiar su clave inicial para que establezca su propia contraseña. Para esto usamos primero el servicio POST/guia/confirmar-correo-propietario
   

4. (Opcional) Podemos utilizar el servicio POST/guia/re-enviar-codigo-validacion para darle la opción al propietario de reenviarse el código de validación en caso de que haya pasado mucho tiempo.
   

5. Para cambiar la contraseña utilizamos los siguientes 2 servicios a la vez (importante usarlos simultáneo para no dejar el proceso sin finalizar y que genere error en el registro):
   POST/guia/cambiar-password
   POST/guia/set-force-change-pass
   

6. Finalmente, le enviamos el correo de bienvenida con el POST/guia/enviar-correo-bienvenida: