Guide de l'espace API

Comment ouvrir un compte intégrateur, souscrire un palier, gérer vos clés et vos webhooks, suivre votre consommation et résilier, écran par écran.

Créer son compte et se connecter

/app/connexion/

L'espace client ne demande pas de mot de passe : vous saisissez votre adresse, et un lien de connexion à usage unique vous est envoyé par courriel. Le même écran sert à ouvrir un compte et à se reconnecter.

Pour un accès à l'API, ouvrez le compte en choisissant « Un éditeur ou un intégrateur ». Ce choix fait apparaître l'onglet API dans la barre latérale et vous dépose sur le portail développeur (/app/api/) à chaque connexion. Il n'ouvre pas encore l'accès aux données : celui-ci commence avec la souscription d'un palier.

Le bouton « Obtenir une clé » de la page /offre-api/ mène à ce même écran, ouvert en mode connexion : choisissez alors « Je crée un compte ».

Champs

Que souhaitez-vous faire ?: Deux choix : « J'ai déjà un compte » (seule l'adresse est demandée) ou « Je crée un compte » (le formulaire d'inscription se déplie).
Votre adresse email: Obligatoire. L'adresse qui recevra le lien de connexion, et l'identifiant du compte. C'est aussi elle que l'écran de suppression du compte vous demandera de retaper.
Vous êtes…: Inscription seulement, obligatoire, aucune réponse pré-cochée. Choisissez « Un éditeur ou un intégrateur » (« Vous branchez nos verdicts sur votre propre outil. Votre espace ouvre le portail développeur, la documentation et les clés. »). Les deux autres réponses ouvrent l'espace des propriétaires ou celui des conciergeries.
Nom: Inscription seulement, obligatoire. Le nom du titulaire du compte.
Prénom: Inscription seulement, obligatoire. Le prénom du titulaire du compte.
Je m'inscris au nom d'une entreprise (recommandé): Case facultative. Pour un intégrateur, le champ « Raison sociale » s'affiche et devient obligatoire même si la case n'est pas cochée.
Raison sociale: Obligatoire pour un compte intégrateur. Le nom de votre structure (l'exemple affiché, « Éditions Logicielles SAS », n'est qu'une indication de forme).
Numéro SIREN de votre structure: Obligatoire pour un compte intégrateur. Neuf chiffres, espaces tolérés. Aide affichée : « Neuf chiffres : ceux de la société qui intègre nos verdicts à son outil. » Le bouton d'envoi reste inactif tant que le numéro n'a pas neuf chiffres. Le numéro est vérifié auprès du répertoire des entreprises : une unité légale inconnue ou cessée est refusée.

Boutons et liens

« Recevoir mon lien de connexion »: Envoie la demande ; le libellé devient « Envoi en cours… ». En cas de succès, le formulaire est remplacé par « Lien de connexion envoyé » : le lien reçu par courriel est valable 15 minutes et ne sert qu'une fois. En l'ouvrant, vous arrivez sur le portail API. Avec « J'ai déjà un compte », le panneau ajoute : « Sinon, vous y recevrez un email pour créer votre compte. »
« Découvrir l'offre conciergeries »: Lien sous le formulaire, vers la page de l'offre conciergeries. Il ne concerne pas l'API.
« Se déconnecter »: En bas de la barre latérale de l'espace, une fois connecté : ferme la session sur cet appareil.

Bon à savoir

« Ce numéro SIREN n'est pas reconnu comme une structure active. Vérifiez-le, ou écrivez-nous. » : le numéro saisi ne correspond à aucune unité légale active. Corrigez-le ; rien n'a été créé.
« Trop de demandes en peu de temps. Réessayez dans un quart d'heure. » : plusieurs liens ont été demandés pour la même adresse ou depuis la même connexion. Attendez quinze minutes.
« L'envoi n'a pas abouti. Vérifiez les informations saisies et réessayez. » : erreur de format ou de réseau, le formulaire reste rempli.
« Ce lien de connexion n'est plus valable : il expire au bout de 15 minutes et ne sert qu'une fois. Saisissez votre adresse pour en recevoir un nouveau. » : le lien a déjà servi ou a expiré ; demandez-en un autre.
La case « Je gère des logements pour le compte de propriétaires tiers… », demandée aux conciergeries, n'est pas proposée à un intégrateur : vous n'avez pas à attester une gestion de logements. Votre compte est enregistré avec votre SIREN et votre raison sociale, sans cette attestation.
Avec « J'ai déjà un compte », une adresse qui n'a pas encore de compte ne reçoit pas de lien de connexion, et aucun compte n'est ouvert : elle reçoit le courriel « Aucun compte Locaclear à cette adresse », dont le lien rouvre cet écran en mode « Je crée un compte », l'adresse déjà remplie.
Sous le nom de votre organisation, la barre latérale affiche « Espace conciergerie », et elle peut afficher un encart « Essai gratuit » avec un bouton « S'abonner ». Ces deux éléments concernent l'abonnement de suivi de portefeuille de l'offre conciergeries, pas l'API : l'accès à l'API se souscrit depuis l'onglet API.

Souscrire un palier

/app/api/

Tant qu'aucun palier n'est en cours, l'onglet API présente l'offre : « Votre organisation n'a pas d'accès à l'API en cours. L'API sert les mêmes règles que cet espace, en machine : verdicts sourcés à l'adresse, table des plafonds de résidence principale, contrôle des numéros d'enregistrement et flux des changements. »

Dessous, trois cartes, une par palier vendu en ligne : Découverte, Croissance et Échelle, chacune avec sa mensualité hors taxes affichée. Le palier Entreprise n'y figure pas : il est sur devis et se contracte directement avec l'éditeur.

Chaque palier fixe trois volumes mensuels — appels de verdict, communes distinctes interrogées, contrôles de numéro — que la grille publique /offre-api/ détaille. Le paiement est confié à Stripe : aucune donnée de carte ne transite par l'espace.

Boutons et liens

« Souscrire »: Au pied de chaque carte de palier. Ouvre la page de paiement Stripe pour ce palier ; pendant l'ouverture, la carte cliquée affiche « Ouverture… » et les autres ne répondent plus. Après paiement, Stripe vous ramène sur /app/api/ ; si vous abandonnez, vous y revenez sans rien avoir payé.
« Découvrir l'offre API »: Ouvre la page publique /offre-api/ : les quatre briques de l'API, les trois états d'une réponse et la grille complète des paliers.
« documentation développeur »: Ouvre /offre-api/documentation/ : authentification, bac à sable, quotas et en-têtes, points d'accès, rappels signés.

Bon à savoir

La période de facturation est ancrée au 1er de chaque mois, l'instant où les compteurs de quota repartent à zéro. Le premier mois, partiel, est facturé par Stripe au prorata des jours restants ; les quotas de ce premier mois, eux, ne sont pas réduits.
Le palier s'active dès que Stripe a confirmé le paiement, en général en quelques secondes. Au retour d'un paiement réussi, l'écran affiche « Paiement confirmé. L'activation de votre palier peut prendre quelques secondes : rechargez la page dans un instant, sans souscrire de nouveau. » — ou « Paiement confirmé : votre palier est actif. » s'il l'est déjà. Si les paliers vous sont encore proposés, rechargez la page après quelques instants plutôt que de cliquer de nouveau sur « Souscrire ».
Si vous abandonnez la page de paiement, l'écran affiche « Paiement annulé : rien n'a été facturé. Vous pouvez choisir un palier à tout moment. » Ces deux messages ne s'affichent qu'au retour de Stripe : un rechargement de la page ne les répète pas.
« Cette offre n'est pas encore ouverte au paiement en ligne. Écrivez-nous et nous l'ouvrons pour vous. » : ce palier n'est pas encore vendable en ligne ; contactez l'éditeur.
« Un palier est déjà actif sur ce compte. Passez par la facturation pour en changer. » : un palier a été activé entre-temps (rechargez la page). Un second abonnement n'est jamais créé : le changement de palier passe par le portail de facturation (voir « Changer de palier ou résilier »).
« La souscription n'a pas abouti. Réessayez dans un instant. » : la page de paiement n'a pas pu être ouverte ; rien n'a été facturé.

Le portail API

/app/api/

Une fois le palier actif, l'onglet API devient le portail développeur. En tête, la ligne « Palier en cours : » donne le nom du palier et sa mensualité hors taxes (aucun montant pour le palier Entreprise), puis deux liens ; à droite, « Mois en cours : » nomme le mois des compteurs.

Dessous, dans l'ordre : trois jauges de consommation, puis, sur grand écran, à gauche le bloc « Clés » et le bloc « Facturation », à droite les blocs « Documentation interactive », « Webhooks », « Demandes de collecte » et « Derniers appels ». Chaque bloc est décrit dans la section qui suit.

Ces écrans gèrent votre intégration ; ils ne remplacent pas la documentation développeur, qui décrit chaque point d'accès, ses paramètres et ses réponses.

Boutons et liens

« Documentation développeur »: Dans la ligne d'en-tête : ouvre /offre-api/documentation/.
« Changer de palier »: Dans la ligne d'en-tête : ouvre le portail de facturation Stripe de votre abonnement API, où le changement se fait (voir « Changer de palier ou résilier »). Au palier Entreprise, sur devis, il ouvre la grille publique /offre-api/.

Bon à savoir

« Chargement… » s'affiche le temps de lire votre accès. « La situation de votre accès à l'API n'a pas pu être chargée. Rechargez la page dans un instant. » signale une panne de lecture, pas une perte d'accès : vos appels à l'API ne sont pas concernés.
Chaque bloc se charge séparément : si l'un d'eux ne peut pas être lu, il le dit dans sa propre phrase et les autres restent utilisables.
Le portail ne s'ouvre que dans l'espace client, avec votre session. Les appels à l'API, eux, se font sur l'hôte de l'API, sous le préfixe /v1, avec une clé : les deux ne se mélangent jamais.

Clés API

/app/api/

Le bloc « Clés » liste les clés en cours de votre organisation. Chaque clé s'affiche par son préfixe (lck_live_ pour une clé de production, lck_test_ pour une clé de bac à sable, suivi de huit caractères, puis « … ») et son libellé, avec la ligne « Créée le … · dernière utilisation : … » (« jamais » tant qu'elle n'a pas servi). Une clé de bac à sable porte en plus un badge « bac à sable », et sa ligne indique « corpus fictif, aucun quota consommé » à la place de la dernière utilisation, qui n'est pas suivie pour ces clés.

Une clé s'envoie dans l'en-tête Authorization de chaque appel, selon le schéma Bearer (Authorization: Bearer lck_live_…). Tous les appels faits avec une clé de l'organisation lui sont imputés et comptent dans ses quotas.

Sans clé en cours, le bloc affiche « Aucune clé en cours. Créez-en une pour appeler l'API. »

Champs

Type de la nouvelle clé: Deux choix : « Clé de production » (coché par défaut) — corpus réel, consomme les quotas du palier — et « Clé de bac à sable » — corpus fictif figé, aucun quota consommé, aucune collecte. Le bac à sable sert les mêmes points d'accès et les mêmes formats de réponse que la production, sur des communes fictives décrites dans la documentation développeur.
Libellé de la nouvelle clé: Le nom qui vous permettra de reconnaître la clé (l'exemple affiché est « Intégration production »). Obligatoire, de 1 à 80 caractères ; les espaces de début et de fin sont retirés. Donnez une clé par usage ou par environnement : c'est ce qui permet d'en révoquer une sans couper les autres.

Boutons et liens

« Créer une clé »: Crée une clé du type choisi avec le libellé saisi ; le libellé devient « Création… ». La clé complète s'affiche alors une seule fois dans un encadré, sous l'avertissement « Copiez cette clé maintenant : elle ne sera plus affichée. », et le message « Clé créée. » (ou « Clé de bac à sable créée. ») confirme l'opération. Pour une clé de bac à sable, l'encadré renvoie à la documentation développeur, qui décrit la commune fictive à interroger. L'encadré n'a pas de bouton de copie : sélectionnez la clé et copiez-la avant de quitter ou de recharger la page.
« Révoquer »: Sous chaque clé en cours. Premier temps seulement : rien n'est encore révoqué. L'avertissement « Une clé révoquée ne peut pas être rétablie. Les appels qui la portent recevront un refus. » apparaît avec deux boutons.
« Confirmer la révocation »: Second temps : révoque définitivement la clé (le libellé devient « Révocation… »). Message : « Clé révoquée. Les appels qui la portent reçoivent désormais un refus. » La clé passe dans la liste repliée des clés révoquées.
« Garder la clé »: Annule la révocation en cours : la clé reste valide, rien n'est modifié.
« Clés révoquées (N) »: Liste repliable, présente dès qu'une clé a été révoquée : préfixe, libellé et date de révocation de chacune. Ces clés ne servent plus et ne peuvent pas être réactivées.
« Documentation développeur »: Au bas du bloc, après « Palier en cours : » : ouvre /offre-api/documentation/.

Bon à savoir

La clé complète n'est montrée qu'à sa création. Seuls son préfixe et une empreinte sont conservés : ni l'écran, ni l'éditeur ne peuvent la réafficher. Une clé perdue se remplace : créez-en une nouvelle, déployez-la, puis révoquez l'ancienne.
Une clé est un secret de serveur. Ne la placez jamais dans du code exécuté chez vos utilisateurs (page web, application mobile), dans un dépôt de code ou dans un ticket : appelez l'API depuis votre serveur, et gardez la clé dans un gestionnaire de secrets ou une variable d'environnement.
Si une clé a fuité, ou au départ d'une personne qui la connaissait, révoquez-la sans attendre : les conditions générales (article 17) imputent à l'organisation les appels faits avec ses clés, y compris par un tiers.
Une clé révoquée, absente ou inconnue reçoit la même réponse de l'API : 401, erreur non_authentifie. C'est aussi la réponse à toutes vos clés quand aucun palier n'est en cours.
« Ce libellé n'a pas été accepté. Donnez à la clé un nom court et non vide. » : le libellé est vide ou dépasse 80 caractères. « La clé n'a pas pu être créée. Réessayez dans un instant. » et « La clé n'a pas pu être révoquée. Réessayez dans un instant. » : panne passagère, rien n'a changé.
« La liste de vos clés n'a pas pu être chargée. Rechargez la page dans un instant. » : la liste n'a pas pu être lue ; vos clés existent toujours et fonctionnent.
La date de dernière utilisation est mise à jour au plus une fois par minute : elle répond à « cette clé sert-elle encore ? », pas à « quand exactement ? ».
Une clé de bac à sable (préfixe lck_test_) ne consomme aucun quota, n'ouvre aucune demande de collecte et ne déclenche aucun webhook ; elle reste soumise au plafond de débit par clé. Comme une clé de production, elle n'ouvre l'API que tant qu'un palier est en cours, et elle se révoque de la même façon.
Au bas du bloc, un rappel chiffré reprend le palier en cours et, pour le mois (au format AAAA-MM), les « Appels de verdict » et « Contrôles de numéro » consommés rapportés au quota du palier (« — » pour un palier sans quota chiffré).

Consommation et quotas

/app/api/

Les trois jauges sous l'en-tête lisent la consommation du mois en cours : « Appels de verdict », « Communes distinctes » et « Contrôles de numéro ». Chacune donne le nombre consommé, le quota du palier après la barre oblique, le pourcentage atteint et une barre de remplissage.

Les compteurs couvrent le mois calendaire et repartent à zéro le 1er du mois suivant, à minuit UTC. Ils sont les mêmes que ceux de l'API : l'en-tête de chaque réponse (famille X-Quota-*) et le point d'accès « moi » les restituent aussi, et la documentation développeur détaille ces en-têtes.

Bon à savoir

« Appels de verdict » compte les demandes de verdict à l'adresse. C'est le seul volume qui porte un tarif de dépassement.
« Communes distinctes » compte les communes différentes interrogées dans le mois, tous usages confondus (verdicts, lecture de commune, plafond à l'unité). Réinterroger une commune déjà vue dans le mois ne consomme rien de plus. Au plafond, les communes déjà interrogées restent servies ; une commune nouvelle reçoit un refus jusqu'au mois suivant ou jusqu'à un palier supérieur.
« Contrôles de numéro » compte les contrôles de numéros d'enregistrement. Au palier Échelle, la jauge affiche « — sans plafond mensuel chiffré, sous plafond de débit par clé » à la place d'un quota.
Au palier Entreprise, aucune jauge ne porte de quota : les trois affichent « — volume convenu au contrat ». Les volumes sont ceux du contrat ; l'écran n'invente aucun plafond.
Au-delà du quota d'appels de verdict, deux cas, que la phrase du bloc « Facturation » vous indique : si votre abonnement porte la facturation au dépassement, l'appel reste servi et se facture au tarif de dépassement (l'en-tête de quota de la réponse compte alors les appels du mois servis au-delà du quota) ; sinon, l'API répond 429 avec l'erreur quota_atteint jusqu'au 1er du mois suivant.
Les contrôles de numéro et les communes distinctes n'ont pas de dépassement : au plafond, l'API répond 429 avec l'erreur quota_atteint (numéros) ou quota_communes_atteint (communes distinctes). Un appel de verdict refusé pour le quota de communes n'est compté ni dans vos appels du mois, ni au dépassement.
Indépendamment du quota mensuel, chaque clé est soumise à un plafond de débit (par minute et par jour) qui borne la cadence des appels. Le dépasser renvoie 429 avec l'erreur debit_depasse ; ralentissez et réessayez. La table des plafonds et le flux des changements ne consomment pas le quota de communes, mais restent soumis à ce plafond de débit.
Les appels faits avec une clé de bac à sable ne consomment aucun quota.

Facturation

/app/api/

Le bloc « Facturation » met vos compteurs du mois en regard de la grille tarifaire. Les montants sont hors taxes et calculés à partir du tarif affiché ; la facture elle-même est émise par Stripe.

Il comporte jusqu'à trois lignes : « Palier [nom] — [mois] » et sa mensualité (ou « sur devis » au palier Entreprise) ; « Dépassement verdicts (N × tarif unitaire) » et son montant, présente seulement si votre abonnement porte la facturation au dépassement ; « Prochaine facture ([date]) » et le total des lignes précédentes, absente au palier Entreprise. La date est le 1er du mois suivant.

Une phrase dit ce qui se passe au-delà de votre quota de verdicts : « Au-delà du quota du palier, l'appel de verdict reste servi et est facturé [tarif] HT. » si votre abonnement porte la facturation au dépassement ; sinon « Au-delà du quota du palier, l'appel de verdict reçoit un refus (429, quota_atteint) jusqu'au 1er du mois suivant : la facturation au dépassement ([tarif] HT l'appel) n'est pas active sur votre abonnement. » Elle est absente au palier Entreprise.

Boutons et liens

« Gérer l'abonnement et les factures »: Ouvre le portail de facturation Stripe de votre abonnement API : factures à télécharger, moyen de paiement, changement de palier.
« Résilier l'abonnement »: Ouvre le même portail de facturation Stripe, pour y arrêter l'abonnement API. Voir « Changer de palier ou résilier ».

Bon à savoir

Le bloc n'apparaît que si sa lecture a réussi. S'il manque, rechargez la page ; les mêmes liens figurent dans la rangée « API » des Réglages.
La ligne « Dépassement verdicts » compte les appels de verdict du mois au-delà du quota inclus dans le palier en cours : ceux que l'API a servis au-delà du quota, et, si vous passez en cours de mois à un palier inférieur, la part de votre consommation qui dépasse déjà son quota. Ces verdicts sont facturés au tarif de dépassement. Sans facturation au dépassement sur votre abonnement, la ligne n'apparaît pas et rien n'est facturé au-delà de la mensualité.
Le montant de « Prochaine facture » est une estimation à l'instant de la lecture : il ne tient compte ni de la TVA, ni d'un prorata appliqué par Stripe lors d'une souscription ou d'un changement de palier en cours de mois. La facture Stripe fait foi pour le montant ; les compteurs de l'éditeur font foi pour les volumes (article 17 des conditions générales).

Webhooks

/app/api/

Un webhook est une adresse de votre serveur à laquelle l'éditeur envoie, sans que vous ayez à interroger l'API, les changements du flux /v1/changements, ainsi que l'issue de vos demandes de collecte. Chaque livraison est une requête POST au corps JSON, signée avec le secret propre au webhook.

Le bloc liste vos webhooks : l'adresse complète et un badge d'état, « actif » ou « coupé ».

Champs

Adresse du webhook: Le champ marqué « https://… ». Saisissez l'adresse complète de votre point de réception, obligatoirement en https (une adresse en http est refusée : la signature ne protège rien sur un canal en clair).

Boutons et liens

« Créer un webhook »: Enregistre l'adresse saisie ; le libellé devient « Création… ». Message : « Webhook créé. » Le secret de signature s'affiche alors une seule fois, sous l'avertissement « Copiez ce secret maintenant : il ne sera plus affiché. » Il n'y a pas de bouton de copie : sélectionnez le secret et copiez-le avant de quitter la page.
« Supprimer »: À droite de chaque webhook. Premier temps seulement : deux boutons apparaissent à sa place.
« Confirmer »: Second temps : supprime le webhook (le libellé devient « Suppression… »). Message : « Webhook supprimé. Plus aucune livraison ne partira vers cette adresse. »
« Garder »: Annule la suppression : le webhook reste en place.

Bon à savoir

Le secret signe chaque livraison : votre serveur doit vérifier la signature avant de croire une notification. Elle voyage dans un en-tête dédié, dont le nom se termine par -Signature, sous la forme sha256= suivie du HMAC-SHA256, en hexadécimal, du corps brut de la requête calculé avec ce secret. Calculez-la sur le corps brut, avant toute analyse du JSON, et comparez en temps constant.
Le secret n'est jamais réaffiché, ni par la liste, ni par l'API. Perdu, il se remplace en créant un nouveau webhook (qui reçoit un nouveau secret) puis en supprimant l'ancien. Rangez-le avec les mêmes précautions qu'une clé.
Votre point de réception doit répondre par un code 2xx dans les cinq secondes. Une livraison en échec est retentée avec un délai croissant. Après huit échecs consécutifs, le webhook est coupé : son badge passe à « coupé » et plus rien n'y est envoyé. L'espace ne propose pas de le réactiver : corrigez votre serveur, puis créez un nouveau webhook et supprimez l'ancien. Le flux /v1/changements, dont le curseur se rejoue, permet de rattraper les changements manqués.
Le corps de chaque livraison porte un champ type : « changement » pour une fiche communale modifiée (mêmes champs qu'une ligne de /v1/changements), « collecte » pour l'issue d'une demande de collecte. Aiguillez sur ce champ.
Un webhook reçoit tous les changements du flux, pas seulement ceux des communes que vous avez interrogées : filtrez de votre côté sur le code INSEE. Il ne reçoit que les changements constatés après sa création ; l'historique antérieur se relit par le flux /v1/changements.
Les livraisons ne partent que tant qu'un palier est en cours : à la fin de l'abonnement API, plus rien n'est envoyé à vos webhooks. Ils ne sont pas supprimés pour autant, et reprennent si vous souscrivez de nouveau un palier.
« Cette adresse n'a pas été acceptée : elle se donne en entier, et en https. » : l'adresse est incomplète ou n'est pas en https. « Le webhook n'a pas pu être créé. Réessayez dans un instant. » et « Le webhook n'a pas pu être supprimé. Réessayez dans un instant. » : panne passagère, rien n'a changé.
« La liste de vos webhooks n'a pas pu être lue. Rechargez la page dans un instant, plutôt que d'en créer un second. » : ne créez pas de doublon, vos livraisons seraient reçues deux fois.
Les webhooks se gèrent aussi par l'API (/v1/webhooks) : la documentation développeur en donne les routes.

Demandes de collecte

/app/api/

Quand vous interrogez une commune absente de la base, ou dont un volet n'est pas couvert, l'API le dit (état « non couvert ») et ouvre une demande de collecte. Le bloc « Demandes de collecte » liste ces demandes, les plus récentes d'abord, avec le nom de la commune, son code INSEE, un badge d'issue et les dates « demandée le … » et, une fois close, « close le … ».

Les trois issues : « Collecte en cours », « Commune couverte » (la commune a été ajoutée à la base) et « Sans conclusion ». Les issues sont aussi envoyées à vos webhooks (type « collecte »).

Bon à savoir

« Sans conclusion : la collecte a eu lieu, mais aucune source publiée n'établit l'un des volets. L'API continue de rendre ce volet « non couvert » ; tout changement ultérieur de la fiche passera par le flux des changements. »
Liste vide : « Aucune demande de collecte : une commune absente de la base, ou dont un volet n'est pas couvert, en ouvre une à son premier appel. Son issue arrive ici et sur vos webhooks (type « collecte »). »
« La liste de vos demandes de collecte n'a pas pu être lue. Rechargez la page dans un instant. » : panne de lecture ; vos demandes ne sont pas perdues.
La liste affiche au plus vos 100 demandes les plus récentes. Le nombre de demandes de collecte qu'une organisation peut ouvrir par jour est plafonné ; au-delà, l'API rend toujours « non couvert », sans ouvrir de nouvelle demande. Aucun délai de collecte n'est promis.
Les appels faits avec une clé de bac à sable n'ouvrent aucune demande de collecte.

Derniers appels

/app/api/

Le bloc « Derniers appels » est le journal de vos appels à l'API, le plus récent d'abord. Chaque ligne donne l'heure (heure de Paris), le code de statut HTTP rendu, la méthode et le chemin appelés, et une durée en millisecondes.

Il sert à vérifier qu'une intégration appelle bien, et à retrouver quel appel a été refusé et pourquoi (code 4xx).

Bon à savoir

Le journal affiche les 50 derniers appels et ne remonte pas au-delà de 48 heures. Liste vide : « Aucun appel depuis 48 heures : le journal ne remonte pas au-delà. Une intégration qui n'a pas appelé cette nuit s'y présente vide au matin. »
« La durée est celle du traitement chez nous, une fois la clé reconnue : ni la vérification de la clé ni le trajet réseau n'y sont comptés. Votre propre mesure lira donc davantage. »
N'y figurent que les appels faits avec une clé de production reconnue. Les appels du bac à sable, ceux refusés faute de clé valide (401) et ceux refusés au plafond de débit (429 debit_depasse) n'y apparaissent pas ; un refus au quota mensuel (429), si.
Le chemin est reconstruit, sans les valeurs que vous avez envoyées : un chemin que l'API ne connaît pas s'écrit « /v1/(hors contrat) », et un curseur de pagination « curseur=… ». Aucune donnée personnelle n'y est conservée.
« Le journal des appels n'a pas pu être lu. Rechargez la page dans un instant : vos appels, eux, sont passés normalement. »

Documentation interactive

/app/api/

Le bloc « Documentation interactive » liste tous les points d'accès du contrat de l'API, engendrés du contrat OpenAPI : pour chacun, la méthode (GET, POST, DELETE) et le chemin complet sous /v1. Le survol d'un chemin affiche son résumé. Une phrase en pied de bloc rappelle que, pour essayer sans consommer de quota, une clé de bac à sable se crée dans le bloc « Clés ».

La référence complète — paramètres, corps des requêtes, exemples curl, états des réponses, quotas, rappels signés, journal des versions — se trouve dans la documentation développeur, /offre-api/documentation/.

Boutons et liens

« Essayer → »: À droite de chaque point d'accès : ouvre la documentation développeur à la fiche de ce point d'accès (paramètres, corps, exemple curl). Il n'exécute aucun appel depuis l'espace.

Bon à savoir

Le contrat est versionné par préfixe d'URL : un champ ajouté reste dans /v1/, un champ retiré ou dont le sens change ouvre un /v2/. Le journal des versions est en fin de documentation.
La documentation développeur renvoie à l'onglet API, bloc « Clés », pour créer les clés de production comme celles de bac à sable.

Changer de palier ou résilier

/app/api/

L'abonnement API se gère dans le portail de facturation Stripe. Deux liens y mènent, dans le bloc « Facturation » du portail et dans la rangée « API » des Réglages : « Gérer l'abonnement et les factures » et « Résilier l'abonnement ». Ils ouvrent la même page ; le second nomme simplement le geste de départ.

Les liens « Changer de palier » (en-tête du portail, carte « Abonnement API » des Réglages) ouvrent ce même portail de facturation, où le changement se fait. Pour comparer les paliers avant de choisir, la grille publique /offre-api/ les détaille.

Boutons et liens

« Gérer l'abonnement et les factures »: Ouvre le portail de facturation Stripe de l'abonnement API : factures, moyen de paiement, changement de palier, résiliation.
« Résilier l'abonnement »: Ouvre le même portail, où la résiliation se confirme. Les effets de la résiliation (date de fin, sommes dues) sont ceux des articles 12 et 17 des conditions générales (/cgv/).
« Changer de palier »: Ouvre le portail de facturation Stripe de l'abonnement API, où le palier se change. Au palier Entreprise, sur devis, il ouvre la grille publique /offre-api/ : le changement se convient alors avec l'éditeur.

Bon à savoir

Un changement de palier s'applique dès que Stripe l'a confirmé : les quotas du nouveau palier valent pour le reste du mois, et les compteurs du mois ne repartent pas à zéro. Passer à un palier inférieur alors que la consommation du mois dépasse déjà son quota de verdicts fait facturer l'excédent au tarif de dépassement si votre abonnement porte cette facturation ; les appels suivants au-delà de ce quota sont alors servis et facturés de même, ou refusés (429) sans elle.
Avant de résilier, révoquez les clés et supprimez les webhooks dont vous ne voulez plus : une fois l'abonnement terminé, le portail n'affiche plus que l'écran de souscription, et ces blocs ne sont plus accessibles. Plus aucune livraison ne part vers vos webhooks après la fin de l'abonnement, mais ceux que vous n'avez pas supprimés reprennent si vous souscrivez de nouveau.
À la fin de l'abonnement, toutes les clés de l'organisation reçoivent un refus (401, non_authentifie). Les clés qui n'ont pas été révoquées redeviennent utilisables si vous souscrivez de nouveau un palier.
Les réponses que vous avez conservées dans vos systèmes, avec leurs sources et leurs dates, peuvent y rester après la fin de l'abonnement pour la preuve de ce que vous saviez et à quelle date, sans droit de rediffusion (article 17 des conditions générales).
Pour un palier Entreprise, ou pour passer au palier Entreprise, adressez-vous à l'éditeur : ce palier est sur devis.

Réglages et suppression du compte

/app/reglages/

Pour un compte ouvert comme intégrateur, les Réglages comptent trois sections, accessibles par la barre d'ancres du haut : « Identité d'émission », « API » et « Compte ». La section « Abonnement » n'y figure pas : elle concerne l'abonnement de suivi de portefeuille de l'offre conciergeries.

La rangée « API » contient la carte « API » — « Palier en cours : [palier]. Clés, usage et facturation ont déménagé dans l'onglet API. » — et la carte « Abonnement API » : un badge « Palier [nom] », la mensualité hors taxes, puis « Appels de verdict inclus », « Communes distinctes », « Contrôles de numéro » et « Dépassement verdict » (tarif par appel). Au palier Entreprise, ces lignes sont remplacées par : « Ce palier est sur devis : ses volumes, son engagement de service et sa licence d'usage sont fixés au contrat, et ne se lisent donc pas dans une grille. » Sans palier en cours, la carte « API » présente l'offre, avec les liens « Découvrir l'offre API » et « documentation développeur ».

Champs

Nom: Section « Identité d'émission ». Obligatoire, 120 caractères au plus. Le nom du titulaire du compte.
Prénom: Obligatoire, 120 caractères au plus.
Raison sociale (si vous en avez une): Facultatif, 120 caractères au plus. Une valeur en forme d'adresse de courriel, ou sans caractère visible, ne peut pas servir de nom : l'écran le signale sous le champ.
Émettre mes rapports et mes factures au nom de cette société: Case qui n'apparaît que lorsque la raison sociale saisie peut servir de nom. Cochée, la raison sociale devient le nom imprimé ; sinon, c'est « Prénom Nom ». La ligne « Nom imprimé : » de l'« Aperçu de l'en-tête » suit la saisie en direct.
Coordonnées (en-tête des documents remis): Facultatif, 500 caractères au plus. Imprimées sous le nom en tête des documents PDF produits depuis l'espace.
Logo (en-tête des documents remis): PNG ou JPEG, choisi par « Téléverser un logo » (puis « Remplacer le logo »), retiré par « Retirer le logo ». Il ne sert qu'aux documents produits depuis l'espace et n'apparaît dans aucune réponse de l'API.
Adresse email de ce compte: Apparaît après « Supprimer le compte ». Retapez l'adresse du compte, affichée entre parenthèses ; la casse et les espaces de début et de fin n'ont pas d'importance.

Boutons et liens

« Enregistrer »: Au pied de la carte « Identité d'émission » ; devient « Enregistrement… ». Message : « Réglages de l'organisation enregistrés. »
« API »: Lien dans la phrase de la carte « API » : ouvre le portail /app/api/.
« Changer de palier »: Carte « Abonnement API » : ouvre le portail de facturation Stripe de l'abonnement API, où le palier se change. Au palier Entreprise, sur devis, il ouvre la grille publique /offre-api/.
« Gérer l'abonnement et les factures »: Rangée « API », quand un palier est en cours : ouvre le portail de facturation Stripe de l'abonnement API.
« Résilier l'abonnement »: Rangée « API », quand un palier est en cours : ouvre le même portail Stripe pour arrêter l'abonnement API (voir « Changer de palier ou résilier »).
« Données conservées pour ce compte »: Section « Compte » : déplie la liste des données conservées et le lien vers la « politique de confidentialité ».
« Supprimer le compte »: Premier temps : fait apparaître la confirmation, et le bouton devient « Annuler la suppression », qui la referme sans rien supprimer.
« Confirmer la suppression »: Inactif tant que l'adresse retapée ne correspond pas à celle du compte. Supprime le compte définitivement (le libellé devient « Suppression… ») et ramène à l'écran de connexion.

Bon à savoir

« Ces informations n'ont pas été acceptées. Le nom et le prénom sont obligatoires ; vérifiez aussi la longueur de la raison sociale et des coordonnées. » : complétez le nom et le prénom, ou raccourcissez le champ trop long. Rien n'a été enregistré.
La suppression du compte est irréversible. Elle efface aussi vos clés, vos webhooks, votre journal d'appels et vos demandes de collecte : toutes vos intégrations reçoivent un refus dès qu'elle est faite.
Résiliez l'abonnement API avant de supprimer le compte, par « Résilier l'abonnement », et attendez qu'il soit terminé — l'onglet API présente alors de nouveau l'écran de souscription. La suppression du compte ne met pas fin, à elle seule, à l'abonnement API chez Stripe.
« Un abonnement est encore rattaché à ce compte. Résiliez-le depuis « Gérer l'abonnement et les factures », puis réessayez. » : un abonnement de suivi de portefeuille (offre conciergeries) est encore actif sur ce compte ; rien n'a été supprimé.
« La confirmation ne correspond pas à [adresse], l'adresse de ce compte. Rien n'a été supprimé. » : retapez l'adresse exacte. « La suppression n'a pas abouti. Réessayez dans un instant. » : panne passagère.
« Les réglages n'ont pas pu être chargés. Rechargez la page dans un instant. » : panne de lecture, vos réglages ne sont pas perdus.

Service d'information — ne constitue ni un conseil fiscal, ni un conseil juridique. Résultats indicatifs, hors régime réel et cas particuliers.