IDpack WebhookIDpack Webhook

La fonctionnalité IDpack Webhook fournit un mécanisme pour notifier les serveurs externes en temps réel lorsque des événements précis se produisent dans le système. Lorsqu’elle est configurée, IDpack envoie des requêtes HTTP POST à une URL webhook spécifiée, permettant une intégration transparente avec des systèmes tiers et assurant la synchronisation des données en temps réel, l’automatisation des flux de travail et le traitement basé sur les événements.

Fonctionnement des Webhooks

  1. Déclenchement de l’événement : Un événement spécifique est déclenché dans IDpack (par exemple, lorsqu’une fiche est ajoutée ou modifiée).
  2. Exécution du Webhook : IDpack envoie une requête POST à l’URL webhook configurée avec les données de l’événement au format JSON.
  3. Validation de la réponse du client : Votre serveur doit répondre avec un code HTTP approprié et un contenu pour confirmer le traitement réussi.
  4. Traitement externe : Les données du webhook peuvent alors être traitées par votre système externe pour effectuer des actions spécifiques, comme la mise à jour de votre base de données ou le déclenchement de notifications.

Authentification et sécurité

  • Authentification de base : IDpack prend en charge l’authentification de base pour sécuriser les requêtes webhook. Vous pouvez fournir un nom d’utilisateur et un mot de passe afin de vous assurer que seules les requêtes autorisées seront acceptées par votre serveur.
  • Chiffrement du contenu : Pour une sécurité accrue, le contenu du webhook peut être chiffré à l’aide d’une clé fournie par IDpack. Cela garantit que les données sensibles restent protégées pendant la transmission.

Coût des Webhooks

Chaque déclenchement de webhook consomme 2 jetons de votre compte. Assurez-vous de surveiller votre solde de jetons afin d’éviter toute interruption de la fonctionnalité webhook.

Réponse requise du client

Pour garantir le succès de l’exécution du webhook, votre serveur doit respecter le format de réponse suivant :

  1. Code de réponse HTTP :200 pour confirmer la bonne réception du webhook.
  2. Format de la réponse JSON :
{ "status": "success", "id": "b029277f-a19b-4601-b303-9a7d3c1be8d5" }

Événements Webhook disponibles

  • producer.record.added – Déclenché lorsqu’une nouvelle fiche est ajoutée.
  • producer.record.updated – Déclenché lorsqu’une fiche est modifiée.
  • producer.record.photo_id_taken – Déclenché lorsqu’une photo d’identité est capturée pour une fiche.
  • producer.record.status_changed – Déclenché lorsque le statut d’une fiche est modifié.
  • producer.record.deleted – Déclenché lorsqu’une fiche est supprimée.
  • producer.record.print_preview – Déclenché lorsqu’un aperçu d’impression est généré pour une fiche.

Pour les utilisateurs du forfait Enterprise, des événements supplémentaires comprennent :

  • producer.record.added_queue – Déclenché lorsqu’une fiche est ajoutée au centre d’impression.
  • producer.record.cancel_queue – Déclenché lorsqu’une fiche est annulée dans le centre.
  • producer.record.removed_queue – Déclenché lorsqu’une fiche est retirée du centre.
  • print_queue.record.print_preview – Déclenché lorsqu’un aperçu d’impression est généré pour une fiche dans le centre.
  • print_queue.record.removed_queue – Déclenché lorsqu’une fiche est retirée du centre.

Structure du contenu JSON

Les contenus des webhooks incluent des détails sur l’événement, la fiche concernée, ainsi que des métadonnées pour le traitement.

{ "id": "751dfc1d-a61a-4c72-b620-eb8975625f3d", "object": "event", "data": { "project_key": "t7e84e46-92d4-11rd-9167-u894daa10b54", "record": { "idc_key": "r2d3y9cf-1f1b-u9c3-a822-wc4c7k5e20f3", "idc_id_number": "679", "idc_rfid_csn": "7820706", "idc_active": "1", "idc_trash": "0", "idc_firstname": "Steve", "idc_lastname": "Smith", "idc_employee_id": "1234", "idc_title1": "Chief Executive Officer", "idc_birthdate": "1970-25-04", "idc_expirationdate": "1998-19-02", "idc_issuedate": "1996-18-02", "idc_function1": "Journalist", "idc_department": "Arts", "idc_url": "https://www.example.com/?id=234234", "idc_insdate": "2023-06-12 13:29", "idc_moddate": "2024-02-03 10:11", "idc_picturedate": "2024-02-03 10:05", "idc_printdate": "2024-03-14 13:10:03" } }, "webhook": { "event": "producer.record.added", "token_price": 2, "remaining_tokens": 55724, "software": "IDpack", "output_format": "json", "version": "3.2.40", "request_date": "2025-01-27 11:23" } }

Cas d’utilisation

  • Synchronisation des données : Mettez automatiquement à jour les systèmes externes lorsqu’une fiche est créée ou modifiée.
  • Notifications : Déclenchez des alertes lorsque des événements spécifiques surviennent, comme une capture photo d’identité ou la suppression d’une fiche.
  • Pistes d’audit : Maintenez des journaux détaillés des actions pour la conformité et le suivi.
  • Automatisation des flux de travail : Optimisez les processus en intégrant les événements IDpack à vos systèmes externes.

En exploitant les webhooks d’IDpack avec des mesures de sécurité robustes, des notifications en temps réel et une gestion efficace des jetons, vous pouvez bâtir des intégrations puissantes pour automatiser vos processus et renforcer la fonctionnalité de votre système.