Ce qui peut être réalisé avec l'API Blue.
L'API Blue est un outil puissant qui vous permet d'interagir avec les données et la fonctionnalité de Blue de manière programmatique. Voici quelques-unes des capacités que vous pouvez réaliser avec l'API Blue :
L'API Blue offre une gamme de capacités puissantes qui vous permettent d'interagir avec les données et la fonctionnalité de Blue de manière programmatique.
Explorons ces capacités plus en détail.
Lire des données
L'API vous permet de récupérer des données spécifiques en une seule requête en utilisant un schéma flexible et précis. Cela signifie que vous pouvez demander exactement les informations dont vous avez besoin, des points de données simples aux structures imbriquées complexes, le tout dans une requête efficace. Cette capacité est particulièrement utile lorsque vous devez récupérer des données de plusieurs entités liées sans effectuer plusieurs appels API.
Écrire des données
Avec l'API Blue, vous pouvez modifier des données sur le serveur en utilisant des mutations. Ces mutations vous permettent de créer de nouveaux enregistrements, de mettre à jour ceux existants ou de supprimer des données selon vos besoins. Cela vous donne un contrôle total sur les données dans votre instance Blue, vous permettant d'automatiser des processus ou d'intégrer Blue avec d'autres systèmes dans votre flux de travail.
Pour les opérations en masse, l'API fournit des mutations spécifiques comme createCustomFieldOptions
, deleteFiles
et uploadFiles
. Bien que des opérations de création/mise à jour en masse générales pour toutes les entités ne soient pas disponibles, vous pouvez traiter efficacement plusieurs opérations en envoyant plusieurs mutations dans une seule requête GraphQL.
Mise à jour en temps réel
L'une des fonctionnalités les plus puissantes de l'API Blue est son support des abonnements. Cela permet aux clients d'écouter les changements de données en temps réel sans avoir besoin de sondage constant. Vous pouvez configurer des abonnements pour être immédiatement informé lorsque certaines données changent, vous permettant de créer des applications réactives qui affichent toujours les informations les plus à jour.
Récupération de données efficace
L'API est conçue pour réduire la surcharge de données. Contrairement aux API REST traditionnelles où vous pourriez recevoir plus de données que nécessaire, avec l'API Blue, vous pouvez spécifier exactement quels champs vous souhaitez récupérer. Cela réduit non seulement la quantité de données transférées sur le réseau, mais améliore également la performance de vos applications en minimisant le traitement des données inutiles.
L'API inclut une limitation de profondeur de requête (maximum 10 niveaux) pour prévenir les problèmes de performance et les abus potentiels dus à des requêtes excessivement imbriquées. Cela garantit des performances optimales tout en permettant toujours une récupération de données complexe.
Introspection du schéma
L'API Blue fournit la capacité de découvrir et d'explorer ses capacités de manière dynamique. Cela signifie que vous pouvez interroger l'API elle-même pour comprendre quelles requêtes, mutations et types sont disponibles. Cette fonctionnalité est incroyablement utile pour les développeurs, car elle permet une exploration facile des capacités de l'API et aide à construire des intégrations robustes et pérennes.