Résumé
L'Interface de Programmation d'Application MindBridge (« API ») vous permet de contrôler les autorisations et l'accès à divers aspects de votre locataire MindBridge, y compris les bibliothèques, organisations, missions et analyses.
Avec l'API, vous pouvez transférer en toute sécurité des fichiers de votre ERP directement dans le gestionnaire de fichiers, importer les données dans une analyse et exécuter l'analyse — le tout depuis l'extérieur de l'application MindBridge. Ensuite, il vous suffit de vous connecter à MindBridge pour voir les résultats de l'analyse.
Découvrez l'utilisation générale de l'API MindBridge.
Détails de configuration
Vous devez être un administrateur de l’application pour accéder à la page de l'API.
Comment puis-je obtenir l'accès à l'API ?
Contactez votre administrateur de l’application pour demander l'accès à l'API MindBridge.
Comment fonctionne une API ?
Une API permet à une application de communiquer avec l'application MindBridge via un ensemble de commandes clairement définies, permettant un accès sécurisé aux actifs et processus de l'entreprise en utilisant une interface REST.
Comme illustré dans l'image ci-dessous, utiliser une API est similaire à passer une commande dans un restaurant. Pensez aux commandes API comme à la commande sur un menu de restaurant — le menu définit une liste de "plats" disponibles (c'est-à-dire des programmes ou des fonctions), et lorsque vous passez une commande, la cuisine (c'est-à-dire le serveur ou la base de données) prépare la nourriture (c'est-à-dire la demande) à l'arrière, puis vous l'envoie lorsqu'elle est prête.
En bref, les API définissent une liste de commandes. Lorsqu'un ERP utilise l'une de ces commandes, MindBridge renvoie ce qui a été demandé.
Qu'est-ce qu'une architecture REST ?
MindBridge utilise une architecture API RESTful, qui permet aux systèmes informatiques d'échanger des informations en toute sécurité sur Internet en utilisant le protocole HTTPS. Les requêtes effectuées via une API RESTful sont sans état, et chaque requête contient toutes les données nécessaires pour compléter la requête avec succès.
Quels sont les avantages de l'utilisation d'une API ?
Les API permettent :
- Une ingestion de données évolutive et l'exportation des résultats en utilisant l'automatisation
- Une plateforme d'analyse de données unifiée, quel que soit le secteur ou les besoins de l'organisation
- Un accès sécurisé et contrôlé aux données de MindBridge, ce qui crée de nouvelles opportunités d'analyses et d'informations à grande échelle
- L'automatisation de tâches complexes et répétitives
Qu'est-ce qu'un jeton d'API MindBridge ?
Un jeton d'API MindBridge (un "jeton d'API") est une chaîne de caractères qui agit comme une clé pour l'API, et est implémenté comme un jeton d'authentification porteur. Il est utilisé en ajoutant le jeton à l'en-tête de chaque requête HTTPS.
Ce type de jeton est un jeton d'authentification cryptographiquement sécurisé qui inclut les autorisations configurées permettant aux clients de l'API d'accéder aux ressources de l'API MindBridge ou aux "points de terminaison".
Comment utiliser le jeton d'API ?
Pour utiliser un jeton généré dans la plateforme MindBridge, vous devez ajouter ce qui suit à l'en-tête de chaque requête HTTPS :
Authorization: Bearer {token} Accept: application/json
Combien de temps durent les jetons d'API ?
Le cycle de vie du jeton est configurable par l'administrateur de l’application pour toute période de temps, jusqu'à un maximum de 2 ans.
Que se passe-t-il si mon jeton d'API est compromis ?
Les jetons doivent être stockés dans un endroit sécurisé, et ne doivent jamais être partagés. La sécurité de votre jeton est primordiale.
Si un jeton est compromis, l'administrateur de l’application doit désactiver et réémettre le jeton immédiatement.
Qu'est-ce qu'un point de terminaison ?
Les points de terminaison sont des fonctions exposées d'une API d'application avec des fonctionnalités fournies par des méthodes HTTPS.
Qu'est-ce qu'une méthode HTTPS ?
Une méthode HTTPS représente une fonctionnalité prise en charge par le protocole HTTPS, telle que GET, POST, PUT, PATCH et DELETE.
Ces méthodes vous permettent essentiellement de lire, écrire ou supprimer des bibliothèques, organisations, missions, analyses, utilisateurs, et bien plus encore.
Comment les jetons d'API sont-ils générés ?
Un administrateur de l’application crée des jetons d'API dans la section Admin de l'application, où ils peuvent appliquer le cycle de vie et les autorisations à chaque jeton.
Découvrez comment créer un jeton d'API MindBridge.
Qui peut accéder et utiliser l'API ?
Toute personne ayant un jeton valide peut utiliser l'API.
Les administrateurs de l’application sont responsables de la gestion des jetons d'API, et peuvent accorder l'accès à l'API à tout utilisateur au sein de la mission.
Comment utiliser l'API ?
Pour utiliser l'API :
- Un jeton d'API doit être généré par un administrateur de l’application dans MindBridge.
- Une fois que vous avez accès au jeton d'API, utilisez le protocole HTTPS pour faire une demande à un point de terminaison documenté dans l'API MindBridge.
Les demandes peuvent être faites à partir de diverses sources, y compris la plupart des langages de programmation ou Postman.
Quel est le format de communication avec l'API ?
L'API utilise JSON pour toutes les requêtes et réponses, à l'exception des fichiers de données, qui peuvent être importés dans n'importe quel format pris en charge par l'application.
Quels formats de fichiers sont acceptés via l'API ?
Entrant
Tous les formats de fichiers actuellement pris en charge par le gestionnaire de fichiers seront acceptés, tels que .xlsx, .csv, .xlsb, et plus encore.
Sortant
Résultats JSON uniquement.
Quels fichiers puis-je envoyer ou recevoir via l'API ?
Entrant
Tous les fichiers actuellement pris en charge par la plateforme MindBridge peuvent être envoyés via l'API.
Les fichiers peuvent être assignés à n'importe quelle source au sein d'une analyse, comme l'emplacement "détail du grand livre général".
Sortant
L'API prendra en charge les résultats d'analyse paginés et interrogeables, indexés soit par transactions, soit par écritures. Les données disponibles sont équivalentes à la table de données dans la plateforme MindBridge.
Où puis-je trouver une documentation plus détaillée ?
Les articles suivants fournissent des détails et des conseils supplémentaires concernant l'API MindBridge.
Pour la documentation technique, ouvrez le menu Actions sur le côté droit de l'onglet API, puis sélectionnez Voir le document de référence de l'API. Vous serez dirigé vers le document de référence de l'API.
Pour voir une liste continue des modifications apportées à l'API, ouvrez le menu Actions sur le côté droit de l'onglet API, puis sélectionnez Voir le journal des modifications de l'API. Vous serez dirigé vers le journal des modifications de l'API.
Pour plus d'informations ou contactez-nous à info@mindbridge.ai.
En tant qu'utilisateur de l'API, par où commencer ?
- Lisez la documentation de l'API MindBridge
- Générez ou obtenez l'accès à un jeton d'API
- Essayez les points de terminaison et actions API souhaités
Autre chose en tête ? Discutez avec nous ou soumettez une demande pour obtenir une assistance supplémentaire.