Veuillez noter que l’accès à l’API peut vous être accordé ou non en fonction de votre formule Semble et/ou de votre rôle.
Si vous avez des questions concernant votre accès à nos API, veuillez contacter assistance@semble.fr
Dans cet article :
- Qu’est-ce que l’API publique Semble ?
- Génération d’une clé API
- Expiration du jeton d’authentification
- Données disponibles via l’API Semble
- Avantages de l’utilisation de l’API Semble
- Requêtes en GraphQL (GQL)
- Mutations en GraphQL (GQL)
- Types en GraphQL (GQL)
- Personnalisation des requêtes avec des arguments
Qu’est-ce que l’API publique Semble ?
L’API publique Semble permet aux cabinets médicaux d’accéder à certaines données et fonctionnalités de Semble afin de les intégrer à leur logiciel existant. Ce service est disponible gratuitement pour tous les cabinets utilisateurs de Semble.
L’API Semble repose sur GraphQL comme langage de requête.
GraphQL (GQL) s’impose rapidement comme la norme API dans de nombreux environnements de développement logiciel. Voici quelques raisons de sa popularité croissante :
- Récupération précise des données : Les clients peuvent spécifier exactement les données souhaitées, évitant ainsi la sur/sous-consommation d’informations.
- Flexibilité : GQL est très flexible et permet d’effectuer des changements côté client sans modifier le serveur.
- Récupération efficace : Avec GQL, vous pouvez obtenir plusieurs ressources en une seule requête, contrairement aux API REST qui nécessitent souvent de multiples requêtes vers différents endpoints.
- Structure basée sur les types et champs : Les API GQL sont organisées par types et champs, pas par endpoints, ce qui garantit que seules les données possibles sont demandées et offre des messages d’erreur plus clairs.
- Intégration avec des systèmes existants : Les API GQL peuvent être reliées à des systèmes REST existants, facilitant la transition entre architectures anciennes et modernes.
Pour plus d’informations sur GQL, cliquez ici.
Génération d’une clé API
Si vous souhaitez utiliser nos API, vous pouvez générer votre clé API comme suit :
1. Rendez-vous dans « Paramètres »
2. Faites défiler jusqu’en bas et cliquez sur « Accès API » dans le menu de gauche
Vous verrez la page suivante :
3. Cliquez sur «Créer» en haut à droite
4. Vous pouvez modifier le nom de vos identifiants si vous le souhaitez, puis attribuer un rôle à cette clé avant d'enregistrer vos changements:
Veuillez noter que l’accès à l’API peut vous être accordé ou non en fonction de votre formule Semble et/ou de votre rôle (vous devez avoir un rôle de manager obligatoirement).
Si vous avez des questions concernant votre accès à nos API, veuillez contacter assistance@semble.fr
Expiration du jeton d’authentification
Les jetons d’authentification sont valables 12 heures. Il est recommandé de vous reconnecter au début de chaque journée.
Pour plus d’informations, cliquez ici.
Données disponibles via l’API Semble
Pour consulter la liste complète des données accessibles via l’API Semble, cliquez ici.
Limite de requêtes API
Pour l’instant, vous pouvez envoyer jusqu’à 240 requêtes par minute à l’API Semble.
Avantages de l’utilisation de l’API Semble
L’API Semble offre de nombreuses possibilités pour optimiser vos workflows et intégrer d’autres systèmes ; par exemple :
- Rapports personnalisés : Récupérez des données analytiques plus détaillées que celles disponibles dans la page Analytique de Semble, pour des rapports sur mesure adaptés à votre structure.
- Systèmes de réservation sur-mesure : Créez votre propre système de prise de rendez-vous avec une interface personnalisée et des questions spécifiques sur votre site web. Lorsqu’un patient réserve via ce système, les données sont transmises à Semble pour une gestion fluide.
- Intégration CRM : Connectez Semble à vos outils marketing et commerciaux. Par exemple, chaque nouveau patient ajouté dans Semble peut être automatiquement synchronisé avec votre CRM pour lancer des campagnes de suivi.
- Intégration d’applications tierces : Si vous avez des besoins non couverts par Semble, vous pouvez intégrer ses données à d’autres applications pour enrichir vos opérations, tout en maintenant la cohérence des dossiers patients sur les différentes plateformes.
- Questionnaires médicaux externes : Utilisez l’API publique Semble pour stocker dans Semble les réponses à des questionnaires médicaux de tiers. Cela fluidifie l’accueil patient et centralise toutes les données.
Pour plus d’informations, cliquez ici.
Requêtes en GraphQL (GQL)
Cliquez ici pour consulter la liste des requêtes disponibles sur Semble.
En GraphQL (GQL), une requête est une demande adressée au serveur pour récupérer des données. C’est l’opération la plus courante en GraphQL, car elle permet d’obtenir exactement les informations souhaitées, ni plus ni moins.
Chaque requête comporte un champ racine qui définit le type de données à obtenir ; les champs précisés ensuite déterminent exactement les données à retourner. Vous pouvez également utiliser des arguments pour filtrer ou affiner votre recherche.
Par exemple, voici une requête simple pour obtenir le nom et l’âge d’un patient :
Le serveur renverra alors les données de ce patient.
Vous pouvez également effectuer des requêtes plus complexes avec plusieurs champs, objets imbriqués et arguments.
Mutations en GraphQL (GQL)
Cliquez ici pour consulter la liste des mutations disponibles sur Semble.
En GraphQL (GQL), une mutation est une requête qui permet de créer, mettre à jour ou supprimer des données. Les mutations sont similaires aux requêtes, mais elles modifient les données au lieu de les récupérer.
Chaque mutation comporte un champ racine qui correspond à l’action principale demandée au serveur.
Après ce champ, vous précisez le payload (données ou modifications à appliquer).
Vous pouvez ajouter d’autres champs au payload pour modifier plus d’informations.
Exemple : une mutation pour créer un nouveau patient dans la base de données d’un cabinet.
La réponse à cette mutation pourrait ressembler à :
Avec les mutations, vous pouvez aussi supprimer ou mettre à jour des données selon vos besoins. Cette opération est flexible et vous permet d’adapter le payload et les arguments à vos cas d’usage.
Types en GraphQL (GQL)
En GraphQL (GQL), le service définit un ensemble de types qui décrivent les données interrogeables.
Cet ensemble de définitions constitue le schéma. Il est essentiel pour comprendre et utiliser GraphQL, car il décrit les types de données disponibles et la façon d’interagir avec elles.
Les principaux composants d’un schéma GraphQL sont les types d’objet, qui représentent les objets accessibles via l’API.
Cliquez ici pour voir la liste des objets disponibles sur Semble.
Chaque type d’objet comporte des champs spécifiques interrogeables. Les champs peuvent avoir différents types de données et des contraintes spécifiques.
Exemple de type d’objet :
type Patient { name: String! insurance: [Insurance!]! }- Patient : le type d’objet représentant un patient, interrogeable via l’API.
- name et insurance : les champs du type Patient, c’est-à-dire les données qu’il est possible de récupérer sur un patient.
- String! : le champ name est une valeur textuelle obligatoire (l’exclamation indique que ce champ doit toujours être renseigné).
- [Insurance!]! : ce champ représente un tableau d’objets Insurance. Le premier point d’exclamation après les crochets indique que le tableau ne peut pas être nul, et le second que chaque élément du tableau est requis.
Personnalisation des requêtes avec des arguments
Les requêtes, mutations et types d’objet peuvent accepter des arguments. Ces arguments permettent de personnaliser les données retournées par votre requête.
Vous pouvez par exemple spécifier quels assureurs récupérer ou limiter le nombre de résultats.
Pour aller plus loin sur les types et la structuration des requêtes, rendez-vous sur le site officiel GraphQL ici.