API

D'autres programmes accèdent à la DocSecBox par l'interface de programmation (API). Sur cette page, vous voyez l'adresse de l'interface, définissez d'où les accès sont autorisés et enregistrez les applications qui peuvent l'utiliser.

Module complémentaire

Accès API est un module complémentaire payant. Sans ce module, l'entrée API n'existe pas sous Paramètres › Application. La page Licence indique s'il est activé.

Réservé aux administrateurs

Seuls les administrateurs voient cette page. Si Seuls les superadmins peuvent modifier les paramètres du programme est activé sous Rôles, seuls les superadmins la voient.

Adresse de l'interface

La carte Interface indique sous URL de base de l'interface HTTP REST l'adresse à laquelle d'autres programmes atteignent l'API. Le lien Documentation de l'API ouvre une description de l'interface. Vous obtenez la spécification complète sur demande auprès de l'exploitant de votre DocSecBox ou du fabricant.

Autoriser l'accès

L'API n'accepte que les requêtes dont vous avez autorisé l'origine. Les deux options sont désactivées par défaut. Tant qu'elles le sont toutes les deux, l'API refuse toute requête, et la page le signale.

1. Ouvrez Paramètres › Application › API.
2. Dans la carte Paramètres d'accès à l'API, cochez l'une des options ou les deux : Autoriser l'accès à l'API depuis des adresses IP internes et Autoriser l'accès à l'API depuis des adresses IP externes.
3. Cliquez sur Enregistrer les paramètres.

C'est l'adresse d'où provient une requête qui compte. Un appel depuis le serveur lui-même ne compte ni comme interne ni comme externe. Aucune des deux options ne le refuse.

Enregistrer une application

Vous enregistrez comme application chaque programme qui utilise l'API. Vous déterminez alors quels utilisateurs reçoivent une clé pour celle-ci.

1. Dans la carte Applications API, cliquez sur Enregistrer une application.
2. Dans la boîte de dialogue Créer une application API, saisissez un nom sous Nom de l'application.
3. Dans la liste des utilisateurs, cochez les comptes qui doivent recevoir une clé. Le champ Rechercher un utilisateur... aide pour les longues listes.
4. Cliquez sur Enregistrer.

À l'enregistrement, chaque compte coché reçoit une clé. Si vous décochez plus tard un compte, sa clé est retirée. Seul l'utilisateur lui-même voit la clé, dans son profil sous Clés tierces. Elle n'est jamais affichée sur cette page.

La liste des applications indique pour chaque ligne le Nom, le nombre d'Utilisateurs ayant une clé et l'État : Actif, Actif jusqu'au avec une date, ou Désactivé. Avec Modifier, vous modifiez une application dans la boîte de dialogue Modifier une application API.

Mettre une application hors service

Une application ne peut pas être supprimée. Vous la mettez hors service au moyen d'une date :

1. Dans la ligne de l'application, cliquez sur Modifier.
2. Cochez Désactiver à partir d'une date et choisissez la date sous Désactivé à partir de.
3. Cliquez sur Enregistrer.

Jusqu'à cette date, les clés des utilisateurs restent valides.