Un seul contrat pour tous les appareils. 38 opérations réparties en cinq groupes de fonctionnalités, disponibles sous forme d'appels REST synchrones et de webhooks Callback en temps réel.
Tous les appels REST sont adressés à un hôte unique et versionné.
https://api.camsbiometrics.com/v3/
Chaque requête transporte un AuthToken lié à votre compte et à votre appareil. Les clés sont délivrées depuis le portail développeurs.
Requêtes encodées en formulaire ou en JSON. Les réponses sont en JSON, avec des champs et des codes d'erreur prévisibles.
Deux façons d'intégrer
Vous appelez la passerelle et obtenez une réponse immédiate. Idéal pour récupérer les présences, lister les utilisateurs, enrôler quelqu'un ou ouvrir une porte à la demande.
Enregistrez une URL et la passerelle vous envoie les événements à l'instant où un appareil les signale — sans polling, avec nouvelles tentatives automatiques en cas d'échec.
Opérations
Regroupées par fonction. Les noms correspondent 1:1 aux endpoints sous-jacents de la passerelle.
Tous les pointages d'une plage de dates sur l'ensemble du compte.
Journaux d'un seul code employé sur une période.
Pointages capturés par un appareil, identifié par son numéro de série.
Synthèse par jour et par employé (entrée/sortie, heures).
Couple première entrée / dernière sortie par employé et par jour.
Instantané en direct des pointages du jour.
Photos capturées associées à un pointage, lorsque l'appareil le permet.
Export en masse pour la paie et le rapprochement.
Créer un utilisateur sur un ou plusieurs appareils.
Modifier le nom, le rôle, la validité ou les privilèges.
Supprimer un utilisateur d'un appareil.
Rechercher un utilisateur par code, avec identifiants en option.
Lister toutes les personnes enrôlées sur un appareil.
Afficher les appareils sur lesquels un utilisateur existe.
Envoyer un modèle d'empreinte à l'appareil.
Enregistrer un modèle de visage, lorsque l'appareil le permet.
Attribuer une carte RFID / de proximité à un utilisateur.
Définir ou modifier le code PIN / mot de passe d'un appareil.
Cloner utilisateurs et modèles d'un appareil à l'autre.
Renvoyer les données d'un utilisateur dans la file d'un appareil.
Déclencher en temps réel un relais de porte, un tourniquet, un portillon, une porte battante ou une barrière levante.
Verrouiller / maintenir une porte sous votre contrôle.
Lire l'état actuel ouvert / fermé.
Définir des plages d'accès horaires.
Journal des entrées / sorties et des événements de porte.
Inventaire de tous les appareils connectés.
Modèle, firmware, capacité et compteurs.
État en ligne, dernière activité et profondeur de la file.
Vérifier immédiatement qu'un appareil est joignable.
Aligner l'horloge de l'appareil sur celle du serveur.
Redémarrer un appareil à distance.
Supprimer de la file les commandes bloquées.
Suivre l'état d'une commande en file d'attente.
Abonner une URL de webhook aux événements en direct.
Déclenché à chaque pointage, en temps réel.
Transitions en ligne / hors ligne et d'état de santé.
Confirmation lorsqu'un modèle arrive sur un appareil.
Suivre l'avancement d'une migration en masse d'appareils / de données.
Des réponses prévisibles
| Code | Signification | Que faire |
|---|---|---|
200 | Succès | Traitez la charge utile JSON. |
401 | AuthToken invalide ou manquant | Vérifiez la clé API et l'appairage de l'appareil. |
404 | Appareil ou utilisateur introuvable | Vérifiez le numéro de série / le code employé. |
409 | Appareil hors ligne / en file d'attente | La commande est mise en file d'attente ; interrogez GetCommandStatus. |
429 | Limite de débit atteinte | Patientez, puis réessayez avec un délai aléatoire (jitter). |
Le guide de démarrage rapide vous mène de la clé API à votre premier journal de présence en quelques minutes.
Nous utilisons des cookies pour mesurer le trafic et améliorer BiometricAPI.com. Les outils d'analyse restent désactivés tant que vous n'acceptez pas. En savoir plus.