Créer une clé

Une clé se crée depuis l'écran « Clés API », réservé aux administrateurs du module API de votre espace.

Créer la clé

1. Ouvrez « API publique », puis cliquez sur « Nouvelle ».
2. Donnez un nom qui dit à quoi sert la clé : « Make — factures », « Zapier — synchro contacts ». Ce nom apparaît comme auteur des fiches que la clé crée.
3. Choisissez une expiration : dans 90 jours, dans 1 an (recommandé), dans 2 ans, ou jamais.
4. Choisissez un ou plusieurs périmètres. La clé verra les fiches et documents de ces périmètres, et seulement ceux-là. Ajoutez au besoin des rôles : ils ouvrent à la clé les entités et les champs CRM réservés à ces rôles, comme à un utilisateur qui les détient. Seul un administrateur de l'organisation peut donner des rôles à une clé.
5. Accordez les accès, entité par entité : « Lecture », « Création », « Modification » ; puis « Lecture » sur les devis, sur les factures, ou sur les deux. Accorder la création ou la modification accorde aussi la lecture : une clé doit pouvoir relire ce qu'elle écrit. Une puce grisée est une opération que l'entité elle-même désactive ; elle ne peut pas être accordée.
6. Cliquez sur « Créer la clé ».

Copier le secret

Le secret de la clé — dlt_ suivi de 40 caractères — s'affiche une seule fois, juste après la création. Copiez-le tout de suite dans le coffre de votre outil. Deltia n'en garde qu'une empreinte : il ne peut plus être relu, par personne.

Si le secret est perdu, révoquez la clé et créez-en une nouvelle.

Révoquer une clé

Dans l'onglet « Révocation » de la clé, tapez son nom exact, puis cliquez sur « Révoquer définitivement ». La révocation est immédiate et définitive : l'appel suivant de l'outil reçoit 401 api-key-revoked.

Ce qui se modifie, et ce qui ne se modifie pas

Le nom et la date d'expiration se modifient depuis l'en-tête de la clé. Ses périmètres, ses rôles et ses accès, jamais : pour les changer, créez une nouvelle clé, puis révoquez l'ancienne.