Ouvrir une base à une API

Un accès ouvre les bases que vous choisissez, et seulement elles, à une boîte noire qui les sert à vos logiciels. Il se crée depuis le bureau ou le web ; l'appli mobile renvoie vers eux.

Tous les paliers peuvent ouvrir une base à une API. Le palier fixe combien d'accès vous pouvez avoir, combien de bases un accès ouvre, si l'écriture et les changements en direct sont compris (à partir de Solo) et si vous pouvez limiter les adresses qui synchronisent (à partir de Pro). Le formulaire affiche vos limites, et les paliers les détaillent.

Avant de commencer

Un compte Filarr connecté sur ce profil, l'appli déverrouillée.
Une base dans une note. Vous devez en être le propriétaire ; pour une base de coffre, le propriétaire ou un administrateur du coffre.
Une base adossée à un dossier (ses lignes sont des fichiers) ou rangée dans votre propre stockage ne s'ouvre pas à une API. Une petite base passe d'abord au stockage des grandes bases de Filarr, quel que soit son poids ; cela ne change rien pour vous.

Ouvrir le formulaire

Sur la base, cliquez sur ··· puis Ouvrir à une API….

L'entrée est grisée, avec la raison, quand la note est en lecture seule, quand aucun compte n'est connecté, quand les grandes bases sont coupées sur cet appareil, ou quand vous n'êtes pas propriétaire ou administrateur du coffre. Si le formulaire affiche Pas encore disponible, les accès API ne sont pas encore ouverts pour votre compte.

Remplir le formulaire

Nom de l'accès : qui s'en servira (« ERP Atelier », « Site »). Il nomme la boîte noire dans Filarr.
Bases ouvertes : la base d'où vous partez est cochée ; cochez-en d'autres pour les ouvrir avec le même jeton. Pour chacune, choisissez Lecture ou Lecture et écriture (l'écriture demande aussi un palier qui la comprend).
Les slugs : le nom de chaque base et de chaque vue dans l'API de la boîte noire, proposé d'après leur titre (clients, clients-actifs). Ils ne se choisissent que maintenant. Ensuite ils ne changent plus, même si vous renommez la base ou une vue : les logiciels qui s'en servent ne cassent pas. Une vue créée plus tard reçoit son slug quand elle est publiée.
Des bases liées restent fermées : si une base a une relation vers une base que vous n'avez pas cochée, le formulaire la nomme. La boîte noire ne lit jamais une base qu'on ne lui ouvre pas : ces relations rendront des identifiants bruts et leurs agrégats seront vides. L'ouvrir aussi l'ajoute.
Expire : dans 6 mois, dans 1 an, ou jamais. À l'échéance, Filarr refuse le jeton et la boîte noire efface sa copie.
Adresses autorisées à synchroniser (à partir de Pro) : Filarr refuse le jeton depuis toute autre adresse IP. Séparez les adresses ou plages par des virgules (203.0.113.7, 10.0.4.0/24) : l'adresse publique de la machine où tourne la boîte noire.

Cliquez sur Créer l'accès.

Garder le jeton

Filarr montre le jeton une seule fois. Copiez-le là où la boîte noire le lira : votre gestionnaire de mots de passe, un secret de votre serveur ou de votre compte Cloudflare. Filarr n'en garde qu'une empreinte : perdu, il se remplace, il ne se retrouve pas. Qui le détient lit les bases qu'il ouvre : traitez-le comme un mot de passe.

L'écran propose quatre façons d'installer la boîte noire (sur ce poste, Docker, dans votre code, Cloudflare) et renvoie à la documentation du dépôt de la boîte noire, qui les décrit pas à pas. Cliquez ensuite sur J'ai mis le jeton de côté. On ne sort de cet écran que par ce bouton : une fenêtre fermée par mégarde perdrait le jeton.

Si d'anciens blocs de la base utilisent une clé que cet appareil ne détient plus, l'écran prévient : la boîte noire les signalera « clé manquante » jusqu'à ce qu'un appareil qui la détient ouvre Filarr.

Et ensuite

Dès sa première synchro, la boîte noire apparaît dans Paramètres → Accès API, avec sa version, son adresse et sa dernière visite : voir Gérer vos accès API. Le tutoriel « Ouvrir une base à une API » du dépôt de la boîte noire montre la suite, côté boîte noire : github.com/filarr-work/filarr-gate.

Si ça ne marche pas

« Seul le propriétaire ou un administrateur du coffre peut ouvrir ses bases » : demandez au propriétaire du coffre.
« Votre palier permet … accès ouvert(s) » : mettez un accès en pause ou révoquez-le dans Paramètres → Accès API.
La boîte noire dit key_missing pour une base : ouvrez Filarr sur un appareil qui détient sa clé, déverrouillé ; les clés sont rescellées.
Voir aussi Dépannage de la boîte noire.