Vocabulaire de la boîte noire

Les mots des accès API et de la boîte noire : accès, jeton, clé d'application, slug, génération, rescellement, et les autres.

Sur cette page
Sections de la documentation

Les mots qu'emploient les écrans des accès API et la documentation de la boîte noire.

motce qu'il veut dire
Accèsce que vous créez par Ouvrir à une API… : un nom, des bases ouvertes (en lecture ou en lecture et écriture), une échéance, des adresses autorisées, un jeton.
Boîte noire (Filarr Gate)le programme qui tient le jeton, déchiffre les bases ouvertes et sert vos logiciels. Elle tourne chez vous : sur un ordinateur, un serveur, votre compte Cloudflare, ou dans votre code.
Jetonflr_live_…, montré une seule fois à la création de l'accès. Il ouvre les bases de l'accès et rien d'autre. Filarr n'en garde qu'une empreinte.
Clé d'applicationgk_…, créée sur la boîte noire pour UN logiciel, limitée à ce qu'il lui faut. Vos logiciels n'ont jamais le jeton.
Slugle nom d'une base ou d'une vue dans l'API (clients, clients-actifs), choisi à la création de l'accès et gardé ensuite, même si vous renommez.
Adresseoù un logiciel lit une base ou une vue : /v1/<slug de la base> ou /v1/<slug de la base>/<slug de la vue>.
Générationle numéro de la clé d'une base. Retirer une base d'un accès, ou révoquer l'accès, la fait passer à la génération suivante : l'ancien jeton ne lit rien de ce qui s'écrit ensuite.
Rescellementquand un de vos appareils remet à un accès la clé d'une nouvelle génération (après un changement de clés pour un autre accès, par exemple). Tant qu'il n'a pas eu lieu, la boîte noire dit « clé manquante ».
Clé manquante (key_missing)la boîte noire n'a pas la clé de certains blocs d'une base : un appareil du créateur de l'accès doit ouvrir Filarr. Elle ne saute jamais un bloc en silence.
Manifesteles vues d'une base telles que la boîte noire les reçoit, scellées pour elle seule. Il est republié quand vous changez une vue, le titre ou les colonnes.
Relèvesans flux en direct (palier Free), la boîte noire demande les changements à intervalle régulier.
Écriture validéeune écriture de la boîte noire acceptée par Filarr. Une validation peut porter plusieurs lignes ; c'est ce que compte la limite d'écritures.
Révoquercouper un accès pour de bon : le jeton est refusé tout de suite, et les clés des bases changent.

Pour aller plus loin