Guía de integración de Housing Market API

Las tablas de referencia, las descripciones de los puntos de conexión, los códigos de error y los ejemplos se generan a partir de la especificación de la API y se mantienen en inglés en todos los idiomas. Los nombres, parámetros y códigos son idénticos en todas partes.

Cómo obtener una clave

Obtiene una clave al suscribirse en la consola. No hay cola de aprobación ni necesidad de enviar ningún correo electrónico.

  1. Inicie sesión en la consola o cree una cuenta. Es la misma cuenta que usa para otros productos de Housing Market.
  2. Elija los países, una región o cobertura mundial, el plan y la facturación mensual o anual.
  3. Introduzca la dirección IP desde la que sus servidores llamarán a la API.
  4. Acepte los términos de uso de la API. Guardamos un registro de lo que aceptó y de cuándo lo hizo.
  5. Pague. Su clave aparece solo después de que el pago se haya completado correctamente, y se muestra una sola vez.

Copie la clave directamente en su almacén de secretos. Solo guardamos un hash unidireccional de ella, por lo que no podemos volver a mostrársela. Una clave tiene este aspecto: hma_<prefix>_<secret>.

Puede crear una clave de reemplazo en la consola en cualquier momento. La clave anterior sigue funcionando durante 24 horas después de hacerlo, para que pueda hacer el cambio sin interrupciones del servicio.

Estados de la clave

  • Activa: la clave funciona.
  • En pausa: la clave se rechaza con key_paused. Se reactiva por sí sola cuando se resuelve el motivo.
  • Revocada: la clave se rechaza de forma permanente con unauthenticated.

Si falla un pago de renovación, su clave sigue funcionando durante un período de gracia de 5 días, en el que le enviamos un correo electrónico en cada paso, y después se pone en pausa. Una clave en pausa se reactiva automáticamente en cuanto se liquida el pago. Una disputa de pago pone la clave en pausa de inmediato hasta que se haya revisado.

Añadir un país o pasar a un plan superior se cobra de forma prorrateada de inmediato y se aplica a la misma clave poco después de confirmarse el pago. Eliminar un país o pasar a un plan inferior entra en vigor en la siguiente renovación.