Support Hub/API & Integrations/Modes Push natif et Push hybride : arbre de décision technique
Translated from the English article and reviewed by a person. Read the English original
Developer

Modes Push natif et Push hybride : arbre de décision technique

Modes Push natif et Push hybride : arbre de décision technique

Chaque appareil biométrique qui se connecte à la passerelle biométrique Cams le fait selon l'un des deux modes push. Le mode utilisé par votre appareil détermine les API disponibles, la manière dont les événements sont transmis et la configuration requise de votre infrastructure. Ce guide présente chaque variable de la décision, du type d'appareil à la méthode de communication en passant par la topologie de déploiement, afin que vous puissiez choisir la bonne voie avant de commencer le développement.

La première question : quel type d'appareil connectez-vous ?

Avant de choisir une méthode de communication ou une topologie de déploiement, il faut répondre à une question plus fondamentale : votre appareil est-il un appareil Cams Biometrics, ou un appareil vérifié sur le portail développeur Cams ?

La réponse à cette question détermine entièrement votre mode push. Si la réponse est oui, vous utilisez le Push natif et aucune autre décision n'est nécessaire. Si la réponse est non, vous entrez dans le domaine du Push hybride, et une série de décisions supplémentaires s'ensuit.

Mode 1
Push natif
Pour toutes les machines Cams Biometrics et tout appareil répertorié comme vérifié sur developer.camsbiometrics.com. L'appareil communique directement avec la passerelle biométrique via Internet, sans configuration supplémentaire.

Toutes les 38 opérations
Callback API complète
RESTful API complète

Mode 2
Push hybride
Pour tous les autres appareils non vérifiés. Vous sélectionnez une méthode de communication et une topologie de déploiement adaptées à votre environnement. La disponibilité des API dépend de la combinaison choisie.

3 méthodes de communication
2 options de topologie
Accès aux API variable

Push natif : vue d'ensemble

Les appareils en Push natif ont un accès complet aux 38 opérations de la passerelle, sans configuration autre que la connexion de l'appareil à Internet. La Callback API transmet les événements avec une latence nulle. Les commandes de la RESTful API s'exécutent en environ 15 secondes. Aucun SDK, aucun logiciel local et aucune décision de topologie ne sont nécessaires.

Comprendre le Push hybride : trois méthodes de communication

Si votre appareil n'est pas un appareil Cams ou un appareil vérifié, la décision suivante porte sur la manière dont la passerelle communiquera réellement avec votre matériel. Trois méthodes de communication sont disponibles. Chacune a des exigences différentes et des implications différentes quant aux fonctionnalités d'API que vous pouvez utiliser.

La méthode de communication ne dépend pas de votre configuration réseau. Elle correspond au mécanisme technique que la passerelle utilise pour lire les données de votre appareil spécifique et lui envoyer des commandes. Ce choix est contraint par les capacités de votre matériel.

a
SDK de l'appareil
Meilleure option pour un accès complet aux API
La passerelle communique avec le matériel à l'aide du SDK du fabricant de l'appareil. Le SDK gère le protocole bas niveau de l'appareil, et la passerelle expose toutes les fonctionnalités prises en charge par le SDK via son API. Il s'agit de la seule méthode de communication du Push hybride qui permet les opérations de la RESTful API.
Callback API complète + RESTful API complète (dans les limites du SDK)
b
DB Pull
Données de présence uniquement
La passerelle lit une base de données locale dans laquelle le logiciel de gestion de l'appareil écrit les enregistrements de présence. La passerelle surveille cette base de données et transmet les nouveaux enregistrements à votre URL de rappel en temps réel. Aucune communication directe avec l'appareil n'a lieu, ce qui signifie qu'aucune commande ne peut lui être envoyée. Les opérations telles que l'ajout d'utilisateurs, la suppression d'enregistrements ou le chargement de journaux ne sont pas disponibles.
Callback API : présences et journaux de pointage uniquement. RESTful API : non prise en charge.
c
Traitement de fichiers
Données de présence uniquement
Un fichier de présence désigné sur l'ordinateur local est placé sous surveillance continue. Chaque fois que le logiciel de l'appareil met à jour ce fichier avec de nouveaux enregistrements de présence, la passerelle détecte la modification, extrait les nouveaux enregistrements et les transmet à votre URL de rappel en temps réel. Comme DB Pull, cette méthode est en lecture seule du point de vue de l'appareil et présente les mêmes limites d'API.
Callback API : présences et journaux de pointage uniquement. RESTful API : non prise en charge.
Comment choisir une méthode de communication

Si votre appareil dispose d'un SDK fabricant pris en charge par la passerelle Cams, choisissez SDK de l'appareil (a). C'est la seule méthode qui débloque les opérations de la RESTful API pour les appareils en Push hybride. Si le SDK n'est pas pris en charge ou n'est pas disponible, DB Pull (b) ou Traitement de fichiers (c) transmettront tout de même les données de présence à votre point de terminaison de rappel en temps réel, ce qui suffit pour de nombreux cas d'usage.

Comprendre le Push hybride : deux topologies de déploiement

Une fois la méthode de communication choisie, la deuxième décision porte sur l'endroit où la passerelle se connecte à votre appareil, à votre base de données ou à votre fichier. C'est la décision de topologie, qui dépend de votre environnement réseau à l'emplacement physique de l'appareil.

Topologie X

Direct
L'ordinateur du site auquel l'appareil est connecté, ou sur lequel le logiciel de gestion de l'appareil s'exécute, dispose d'une adresse IP publique avec une redirection de port configurée vers le réseau local. La passerelle biométrique se connecte directement à l'appareil, à la base de données ou aux fichiers via Internet.
Requis : IP publique + redirection de port sur le site
Topologie Y

Indirect
Une application Hybrid Connector est installée sur l'ordinateur local du site. Elle sert de pont sortant entre la machine locale et la passerelle biométrique, en établissant la connexion depuis l'intérieur au lieu d'exiger une connexion entrante. Aucune IP publique n'est nécessaire côté client.
Requis : Hybrid Connector installé sur l'ordinateur local. Aucune IP publique nécessaire.
Recommandation de topologie

Si vous ne pouvez pas configurer une IP publique ou une redirection de port sur le site, choisissez la topologie Indirect (Y) avec le Hybrid Connector. C'est la voie de déploiement la plus simple, et elle évite entièrement toute configuration réseau côté client. Si une IP publique est disponible et configurée, la topologie Direct (X) fonctionne également et ne nécessite l'installation d'aucun logiciel supplémentaire sur le site.

L'arbre de décision : quel mode devez-vous choisir ?

Parcourez cet arbre de décision de haut en bas. Arrêtez-vous à la première réponse qui correspond à votre situation.

Arbre de décision, à partir du haut
1. Votre appareil est-il un appareil Cams Biometrics, ou est-il répertorié comme vérifié sur developer.camsbiometrics.com ?
Oui Utilisez Push natif. Accès complet aux API. Aucune autre décision nécessaire.
Non Passez à la question 2.
2. La passerelle Cams prend-elle en charge le SDK du fabricant de votre appareil ?
Oui Utilisez Push hybride, SDK de l'appareil (a). Accès complet aux Callback et RESTful API dans les limites du SDK. Passez à la question 3 pour la topologie.
Non Passez à la question 2b.
2b. Le logiciel de gestion de votre appareil écrit-il les enregistrements de présence dans une base de données locale ?
Oui Utilisez Push hybride, DB Pull (b). Callback uniquement pour les présences. Passez à la question 3 pour la topologie.
3. L'ordinateur du site dispose-t-il d'une adresse IP publique avec une redirection de port disponible ?
Oui Utilisez Topologie Direct (X). Aucun logiciel supplémentaire n'est nécessaire sur le site.
Non Utilisez Topologie Indirect (Y). Installez le Hybrid Connector sur l'ordinateur local du site.

Matrice de disponibilité des fonctionnalités du Push hybride

Le tableau ci-dessous présente toutes les combinaisons de méthode de communication et de topologie de déploiement, ainsi que les fonctionnalités d'API disponibles dans chaque cas. Utilisez-le en complément de l'arbre de décision pour confirmer ce que prend en charge la configuration choisie.

Mode Communication Topologie Callback API RESTful API
Appareil direct (a) SDK de l'appareil (X) IP publique Complète Complète (limites du SDK applicables)
Appareil indirect (a) SDK de l'appareil (Y) Hybrid Connector Complète Complète (limites du SDK applicables)
BD directe (b) DB Pull (X) IP publique Présences uniquement Non prise en charge
BD indirecte (b) DB Pull (Y) Hybrid Connector Présences uniquement Non prise en charge
Fichier direct (c) Traitement de fichiers (X) IP publique Présences uniquement Non prise en charge
Fichier indirect (c) Traitement de fichiers (Y) Hybrid Connector Présences uniquement Non prise en charge
Mise en garde importante sur le matériel

Les limitations matérielles peuvent restreindre davantage les fonctionnalités d'API, même en mode SDK de l'appareil. Certaines API peuvent ne pas fonctionner selon la version du micrologiciel du modèle d'appareil ou les capacités exposées par le SDK du fabricant. La matrice ci-dessus décrit ce que prend en charge l'architecture de la passerelle, et non ce que chaque modèle d'appareil est garanti de prendre en charge. Testez toujours avec votre matériel spécifique et vérifiez les cas limites auprès de l'équipe support Cams avant tout déploiement en production.

Ce que la décision de topologie affecte et n'affecte pas

Une confusion fréquente concerne le lien entre la topologie et la disponibilité des API. Le choix de la topologie, Direct ou Indirect, n'affecte pas les fonctionnalités d'API disponibles. Le jeu de fonctionnalités d'API est entièrement déterminé par la méthode de communication.

La topologie influe en revanche sur la manière dont la connexion réseau entre la passerelle et votre environnement local est établie. La topologie Direct nécessite une IP publique et une redirection de port sur le site. La topologie Indirect nécessite l'installation du Hybrid Connector sur la machine locale. Les fonctionnalités d'API disponibles sont identiques pour SDK de l'appareil en Direct et en Indirect, et identiques pour DB Pull en Direct et en Indirect.

“Choisissez votre méthode de communication en fonction des fonctionnalités d'API dont votre intégration a besoin. Choisissez votre topologie en fonction de ce que votre environnement réseau permet. Ce sont des décisions indépendantes.”

Questions fréquentes

Puis-je utiliser DB Pull ou le Traitement de fichiers en parallèle des commandes de la RESTful API ?
Non. DB Pull et le Traitement de fichiers sont des méthodes d'intégration en lecture seule. Elles permettent à la passerelle d'observer les données de présence générées par le logiciel propre à l'appareil, mais elles n'établissent pas de canal permettant de renvoyer des commandes à l'appareil. Les opérations de la RESTful API, comme l'ajout d'utilisateurs, la suppression d'enregistrements ou le chargement de journaux, nécessitent le mode SDK de l'appareil, qui crée un canal de communication bidirectionnel.
Le Hybrid Connector doit-il être installé sur la même machine que le logiciel de l'appareil ?
Oui. Le Hybrid Connector doit être installé sur le même ordinateur local que celui auquel l'appareil est connecté ou sur lequel le logiciel de gestion de l'appareil s'exécute. En effet, il a besoin d'un accès local à l'appareil, à la base de données locale ou au fichier de présence, selon votre méthode de communication. Le Connector crée ensuite un tunnel sortant vers la passerelle, ce qui supprime le besoin d'une IP publique à cet emplacement.
Quelle est la différence de latence entre le Push natif et le Push hybride ?
En Push natif, les événements de la Callback API sont transmis avec une latence nulle, et les commandes de la RESTful API s'exécutent en environ 30 secondes. En Push hybride avec SDK de l'appareil, la latence dépend du cycle de communication propre au SDK et varie selon le fabricant de l'appareil. La latence de DB Pull et du Traitement de fichiers dépend de la fréquence à laquelle le logiciel local écrit de nouveaux enregistrements et de la rapidité avec laquelle la passerelle détecte la modification, généralement quelques secondes après l'enregistrement de l'événement par l'appareil.

Conclusion : adaptez votre mode à vos contraintes

Le choix du mode de connexion à la passerelle biométrique Cams n'est pas une question de préférence, mais de contraintes. Le Push natif est la bonne réponse si votre appareil est éligible, car il offre le plus de capacités avec le moins de configuration. Le Push hybride est la réponse pour tous les autres cas, et au sein de celui-ci, le mode SDK de l'appareil offre l'équivalent le plus proche du Push natif en termes d'accès aux API.

Lorsque l'accès complet au SDK n'est pas disponible, DB Pull et le Traitement de fichiers sont des solutions pragmatiques qui transmettent tout de même les données de présence en temps réel à vos systèmes. La décision de topologie constitue alors un choix distinct, de niveau infrastructure, qui ne modifie pas ce que l'API peut faire.

Commencez par l'arbre de décision, confirmez votre choix à l'aide de la matrice des fonctionnalités, testez avec votre matériel et vérifiez les cas limites auprès de l'équipe support Cams avant la mise en production.

Was this article helpful?