Aller au contenu

Documentation

Authentification

L'en-tête Authorization, les clés de production et de test, les portées, le plafond par clé.

L'en-tête Authorization

Chaque requête porte la clé dans l'en-tête Authorization, après le mot Bearer. L'API ne la lit nulle part ailleurs : ni dans l'adresse, ni dans un cookie.

Authorization: Bearer pk_live_...

Sans clé, l'API répond 401 `cle_absente` ; avec une clé inconnue, révoquée ou expirée, 401 `cle_invalide`, avec l'en-tête WWW-Authenticate. Des échecs répétés depuis une même adresse sont freinés : 429 `trop_de_requetes`.

Production et bac à sable

pk_live_
Production : chaque appel réussi est débité en crédits.
pk_test_
Bac à sable : une réponse sur le jeu figé de l'opération, sans débit. Hors de ce jeu, ou pour une opération sans bac à sable, 403 `hors_bac_a_sable`.

Opérations servies qui ont un bac à sable : Recherche d'annonces analysées, Pige complète : annonces actives et retirées du lac, Résoudre une adresse ou un point, Échéance de location et coût de sortie de passoire, Terrain de référence d'une maison, Marché d'une commune, Synthèse complète d'une commune, Score Pillr et scores d'une commune, Profil socio-démographique et politique, Parc de logements d'une commune, Prix au m² d'une commune : barème, série, évolutions, Prix au m² par quartier IRIS, Prix d'un département ou d'une région, Vie des annonces d'une zone, Tableau mensuel des signaux d'une commune, Radar de prospection d'une commune ou d'un département, Classement de communes (screener), Analyse rédigée d'une commune, Signaux de valorisation d'une commune, Contours, centre et voisins d'un territoire, Tuiles vectorielles de la carte des prix, Référentiels de communes et de codes postaux, Verdict d'investissement d'une commune, Comparaison de communes, Palmarès de communes par indicateur, Avis des investisseurs sur une commune, Loyer de marché d'un logement, Encadrement des loyers, Zonage ABC, plafonds et contraintes locales, Rendement, cash-flow et crédit, Taux de crédit du moment, Simulation fiscale sur l'horizon de détention, Plus-value immobilière à la revente, Taxe d'aménagement d'un projet, Marché de la courte durée d'une commune, Revenu de courte durée d'un logement, Risques naturels et technologiques, Équipements, accès, délinquance et cadre de vie, Résultat : règlement du PLU lu et cité, Démarche d'urbanisme d'un projet, Résultat : dossier de dépôt, Cerfa d'urbanisme pré-rempli, Échéances d'un dossier après dépôt, Agences actives et parts de marché d'une commune, Agences et réseaux immobiliers, Agents et mandataires, Prime de division d'une commune, Indice Travaux et état du parc en vente, Baromètre, Fiches de mesure des modèles, Constantes réglementaires et fiscales de référence, Catalogue des jeux de données, Lecture structurée d'un jeu de données, Agrégats sur un jeu de données, État des sources.

Ce que Pillr garde

  • Une empreinte de la clé et ses premiers caractères, pour la reconnaître dans le tableau de bord : jamais la clé elle-même.
  • La clé ne s'affiche qu'une fois, à sa création. Perdue, elle se révoque et se remplace.
  • Une clé révoquée cesse de répondre dès l'appel suivant.

L'API répond à toute origine : une clé publiée dans le code d'une page web sert à quiconque la lit. Appelez l'API depuis votre serveur, jamais depuis le navigateur de vos utilisateurs.

Portées et accès

Chaque opération exige une portée et un accès. L'accès dit qui peut l'appeler : à l'usage ou avec l'abonnement Data, avec l'abonnement Data, sur contrat. Une opération hors du champ de la clé ou de l'organisation répond 403 `portee_insuffisante` ; une opération qui exige un accès que l'organisation n'a pas, 403 `palier_insuffisant`. La référence de chaque opération donne sa portée, son accès et ses erreurs possibles.

Client final et plafond par clé

Une clé peut porter la référence d'un client final, pseudonyme (jamais un email ni un téléphone), et un plafond mensuel de crédits. Le plafond atteint, ses appels répondent 429 `plafond_cle` jusqu'au mois suivant ; les autres clés de l'organisation continuent. Les deux se règlent dans le tableau de bord.

Guide suivant : Crédits et facturation

    Authentification | Pillr Data