API d’Secure Connect
L’interface de programmation d’application (API) Secure Connect donne aux systèmes externes l’accès aux données Secure Connect. Les informations suivantes sont accessibles via les API :
- Données d'alarme
- Données en temps réel
- Données de station
- Données du dispositif
- Données client
- Données utilisateur
Les API de l’Secure Connect sont utilisées uniquement pour recevoir les données. L’utilisateur ne peut pas contrôler les appareils ni modifier les données via les API Secure Connect en ajoutant un client externe.
Ajout d’un client externe
- Connectez-vous à Secure Connect.
- Allez à Admin > Clients.
- Sélectionner un client
- Aller à l’onglet Clients externes.
- Cliquez sur le bouton Ajouter.
- Saisir un nom.
- Saisir une description.
Il est facultatif d’écrire une description. - Cliquer sur Enregistrer.
Un client externe est créé et l’utilisateur obtient un ID client Auth0 unique et un secret client Auth0 unique. Il est important d’enregistrer le secret client car il n’est affiché qu’une seule fois. Le secret client est requis pour accéder aux API REST Secure Connect. Si l’utilisateur oublie le secret client, un nouveau client externe doit être créé.
Documentation API
La documentation API Secure Connect est disponible dans l’application Secure Connect. Pour accéder à la documentation API Secure Connect :
- Connectez-vous à l’application Secure Connect.
- Cliquez sur l’icône de profil en haut à droite.
- Cliquez sur Ressources client externe .
- Cliquez sur le lien API pour télécharger le fichier YAML API Secure Connect.
Le fichier téléchargé contient les informations suivantes.
- Chemins API REST
- Format de demande
- Format de réponse
- Informations sur le schéma
Pour en savoir plus sur le mécanisme d’authentification Secure Connect et comment appeler les API Secure Connect, cliquez sur le lien Guide d’installation sur les ressources du client externe. Le fichier téléchargé contient les informations suivantes :
- Configuration d’un client externe
- Récupération du jeton JWT pour authentification
FAQ associée
De nombreux utilisateurs ont eu des questions similaires sur Analytics, Live Data, API et OPC UA Connector.