Guide d’intégration de la Housing Market API

Les tableaux de référence, les descriptions des points de terminaison, les codes d’erreur et les exemples sont générés à partir de la spécification de l’API et restent en anglais dans toutes les langues. Les noms, paramètres et codes sont identiques partout.

Obtenir une clé

Vous obtenez une clé en vous abonnant dans la console. Il n’y a ni file d’approbation ni e-mail à envoyer.

  1. Connectez-vous à la console ou créez un compte. Il s’agit du même compte que celui que vous utilisez pour les autres produits Housing Market.
  2. Choisissez les pays, une région ou le monde entier, la formule, ainsi qu’une facturation mensuelle ou annuelle.
  3. Saisissez l’adresse IP depuis laquelle vos serveurs appelleront l’API.
  4. Acceptez les conditions d’utilisation de l’API. Nous conservons une trace de ce que vous avez accepté et de la date à laquelle vous l’avez fait.
  5. Payez. Votre clé n’apparaît qu’une fois le paiement réussi, et elle n’est affichée qu’une seule fois.

Copiez la clé directement dans votre coffre de secrets. Nous n’en conservons qu’un hachage à sens unique ; nous ne pouvons donc pas vous la montrer à nouveau. Une clé se présente ainsi : hma_<prefix>_<secret>.

Vous pouvez créer une clé de remplacement dans la console à tout moment. L’ancienne clé continue alors de fonctionner pendant 24 heures, ce qui vous permet de basculer sans interruption de service.

États de la clé

  • Active : la clé fonctionne.
  • Suspendue : la clé est refusée avec key_paused. Elle est réactivée d’elle-même lorsque le motif de la suspension est résolu.
  • Révoquée : la clé est définitivement refusée avec unauthenticated.

Si un paiement de renouvellement échoue, votre clé continue de fonctionner pendant un délai de grâce de 5 jours, au cours duquel nous vous envoyons un e-mail à chaque étape, puis elle est suspendue. Une clé suspendue est réactivée automatiquement dès que le paiement est réglé. Une contestation de paiement suspend immédiatement la clé jusqu’à ce qu’elle ait été examinée.

L’ajout d’un pays ou le passage à une formule supérieure est facturé immédiatement au prorata, et s’applique à la même clé peu après la confirmation du paiement. Le retrait d’un pays ou le passage à une formule inférieure prend effet au prochain renouvellement.