betterbroker

Api Keys

Lista de registros y uso de apikeys para integraciones

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).
  • Informacion de usuarios de la oficina.

Este apartado están disponible ú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.

Portales


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.

Portales

Importante: La clave de API Key debe estar activa para poder usar los endpoints.

Endpoints disponibles

Accede a la documentación para conocer detalles de implementación de los endpoints disponibles para tus Api keys, consulta nuestra sección de desarrolladores.


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.