Ir al contenido principal

API

Integraciones externas mediante API

Actualizado esta semana

Nota informativa:

La anterior versión de la API de witei finalizó su disponibilidad el pasado mes de Agosto de 2024. Por motivos técnicos, se mantuvo activa de forma extendida para determinados escenarios.

Solicitud de habilitación de la API Clientes

Witei ofrece la posibilidad de solicitar una integración vía API de un sistema externo. La "API Clientes" no es de acceso inmediato. Requiere una validación previa por parte del equipo de Witei que tarda entre 2 y 3 semanas.

Para ello, te rogamos contactes con el equipo de witei para:

  1. Informar del objetivo de la integración API.

  2. Detallar la estimación de peticiones, origen de las peticiones (IPs) y frecuencia de las mismas.

Con esta información, el equipo de witei te ayudará a planificar un uso correcto de la API. Una vez revisado, se habilitará el la herramienta API Clientes en tu espacio de trabajo y podrás iniciar la configuración de Acceso.

Configuración de acceso API de clientes

Una vez completado el proceso de solicitud, el equipo de witei te confirmará la activación de la herramienta "API Clientes" en tu espacio de trabajo.

A continuación, podrás seguir los siguientes pasos para configurar el acceso API:

Paso 1: creación de un usuario específico para acceso API

Witei recomienda la creación de un usuario específico dentro del espacio de trabajo que será el que tenga asociado el acceso API.

Por motivos de seguridad, este usuario deberá tener la siguiente configuración de permisos:

  1. No podrá ser un usuario de tipo administrador

  2. No podrá tener el permiso "Cambio entre espacios de trabajo de la red"

  3. Solo podrá tener acceso a "Ver" y "Editar" sus propios Contactos, Inmuebles y Tareas.

  4. Deberá tener activo el permiso "Acceso API" (al final del listado de permisos).

Paso 2: obtención de token API

La conexión vía "API Clientes" requiere de un token único generado para el usuario creado en el Paso 1. Los pasos para obtenerlos serán:

  1. Cierra la sesión de tu usuario actual y accede al nuevo usuario creado con el permiso "Acceso API".

  2. Dirígete al área de Configuración > Integraciones > API

  3. Haz clic en "Invalidar token actual y generar uno nuevo"

Notas importantes sobre el token API:

  • Este token permite a la persona que lo tenga acceso a los contactos, inmuebles tareas, etc. almacenados en el espacio de trabajo bajo las condiciones especificadas por los permisos en el "Paso 1".

  • No compartas este Token con terceros que no sean de tu confianza

  • Regenera el token cada cierto tiempo (como recomendación, cada 3 meses).

  • No compartas este Token con el equipo de Witei en una conversación con soporte.

  • En caso de sospechar que tu Token está siendo utilizado por un tercero sin autorización: accede al área de configuración > integraciones > API y regenera el token lo antes posible.

Paso 3: obtención de token API

En el mismo área de Configuración > Integraciones > API podrás acceder a la documentación técnica donde se explica cómo usar el token para realizar la verificación de identidad al realizar peticiones a la ".API Clientes"

Alternativas a la "API Clientes"

  1. Integración mediante XML

    • Witei proporciona la posibilidad de exportar datos en formato XML.

    • Este formato es ampliamente utilizado en el sector y permite que otros portales, webs o aplicaciones puedan importar la información de manera estructurada.

  2. Integración mediante Webhooks

    • Los webhooks permiten que Witei notifique automáticamente a un sistema externo cuando ocurre un evento determinado (por ejemplo, la creación o actualización de un inmueble).

    • De esta manera, se pueden mantener sincronizados los datos entre Witei y otras aplicaciones en tiempo real.

Preguntas frecuentes

¿Puedes usar Uso de la "API de Clientes" para sincronizar una web externa?

No. Witei no permite este tipo de integraciones debido a su altísima propensión a fallos que impiden el correcto funcionamiento de las webs externas. Si deseas mostrar tus inmuebles almacenados en witei sigue las indicaciones de nuestra guía:

¿Witei da soporte a integraciones externas realizadas vía API Clientes?

Witei no realiza auditorías o soporte sobre las integraciones de terceros. En caso de que detectes un comportamiento no esperado de la API, puedes contactar con el equipo de soporte incluyendo esta información:

  • Petición realizada en formato CURL sin incluir la cabecera con el Token e incluyendo la URL utilizada y el cuerpo de la petición (si corresponde)

  • Respuesta obtenida: Código HTTP de respuesta y cuerpo de la respuesta (formato JSON)

  • Respuesta esperada

¿Ha quedado contestada tu pregunta?