Api Keys

Descripción General

La sección Claves API provee un mecanismo de autenticación para integraciones externas.
Mediante una API Key, los administradores pueden solicitar información relacionada con:

• Inventario de propiedades (listings).
• Información de oficina.
• Creación de nuevos prospectos (leads).

Estas claves están disponibles únicamente para usuarios con permisos de administrador y permiten establecer integraciones seguras con otros portales o aplicaciones.

La información retornada por los servicios corresponde siempre al contexto de la oficina asociada.

Registro de API Keys

Cada registro de API Key contiene la siguiente información:

• Nombre: Identificación asignada por el usuario administrador para reconocer la clave.
• API Key: Cadena alfanumérica única utilizada como credencial de acceso.
• Fecha de Creación: Día en que fue generada la clave.
• Último Acceso: Fecha de la última vez que la clave fue utilizada.
• Copiar: Opción rápida para copiar la clave al portapapeles.
• Estatus: Define si la clave está Activa o Inactiva.

Creación de API Keys

Los administradores pueden generar nuevas claves asignando un nombre descriptivo.
Una vez creada, la API Key estará disponible para su uso inmediato.

Endpoints Disponibles

Las API Keys permiten consumir los siguientes endpoints:

Inventario de Propiedades

GET /v2/listings?apikey=TU_API_KEY
Accept: application/json

• Obtiene el listado de propiedades disponibles en el inventario.

Información de Oficina

GET /v2/offices?apikey=TU_API_KEY
Accept: application/json

• Recupera los datos de la oficina asociada a la API Key.

Creación de Prospectos

POST /v2/leads?apikey=TU_API_KEY
Accept: application/json

• Permite registrar nuevos prospectos (leads) desde aplicaciones externas o portales integrados.

Formatos de Respuesta

Las solicitudes realizadas con una API Key pueden devolver la información en dos formatos:

• JSON (application/json)
• XML (application/xml)

El formato deseado debe especificarse en el encabezado de la petición HTTP utilizando el parámetro Accept.

Ejemplo de encabezados:

GET /v2/listings?apikey=TU_API_KEY
Accept: application/json

Consideraciones de Seguridad

• Las API Keys deben ser tratadas como credenciales confidenciales.
• Se recomienda rotar periódicamente las claves para mayor seguridad.
• Solo los administradores pueden generar o gestionar API Keys.
• En caso de comprometerse una clave, debe ser desactivada inmediatamente.