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

• Para pruebas aisladas ingresar al swagger de la API GCI: https://api-gci-rest.integracionplanok.io/docs/#/

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

  Open

  

• Para comenzar a usar la API se debe ingresar una API Key que autorizará el uso de los servicios

  Open

  

1. ¿Cómo registrar a un propietario?

• Utilizar el servicio POST /guia/registrar-propietario-pivote para registrar inicialmente al propietario en la BD de propietarios, este registro inicial lo realiza el sistema comercial al ingresar las fechas de firma cliente e inmobiliaria en la promesa del negocio:
  
  

• Si utilizamos el punto 1 para registrar los propietarios en la BD de propietarios debemos luego enviar el correo de bienvenida con el POST /guia/enviar-correo-bienvenida. Como se menciona en el punto anterior, si las fechas de promesa las ingresamos en el sistema comercial esto se hará de forma automática desde allí.
  
  

• Luego de que el sistema comercial envía el correo de bienvenida al propietario , se deben realizar los siguientes pasos: utilizar el servicio POST /guia/registro-inicial-propietario. Ingresar el rut sin dígito verificador del propietario para registrarlo inicialmente en base de datos interna de credenciales (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. Una vez que el cliente cuenta con el código se debe ingresar y confirmar junto a su correo, si ambos datos son correctos se podrá asignar luego una contraseña:
  
  

• (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.
  
  

• 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
  
  

2. Login y recursos de aplicación

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

   

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

   

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

   

• 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):
  
  

   

• 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:
  
  

   

• 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