Créer des points d'ancrage dans ClearID - ClearID

Vous pouvez créer des points d'ancrage dans Genetec ClearID™ pour intégrer des API de solutions tierces, afin de pouvoir notifier les parties prenantes lorsque certains événements surviennent.

1. Sur la page Accueil, cliquez sur Administration > Points d’ancrage.
2. Cliquez sur Ajouter un point d’ancrage.
   
3. Dans la section Général, remplissez les champs :
   1. (Facultatif) Déplacez le curseur Activé pour activer ou désactiver le point d’ancrage.
      REMARQUE : Lorsque le point d’ancrage est désactivé, le rappel HTTP ne se produit pas.
   2. Dans le champ Nom, saisissez un Nom représentatif afin de pouvoir facilement identifier votre point d’ancrage ultérieurement.
      Par exemple, Identité mise à jour ou Point d’ancrage Demandes d’identité créées, etc.
   3. Dans le champ Description, saisissez un texte qui décrit l’objectif du point d’ancrage.
      Par exemple, à quoi sert le point d’ancrage et quelle API (programme ou application) il notifie lorsque des évènements se produisent.
4. Dans la section Détails du point d’ancrage, remplissez les champs :
   1. Saisissez une URL HTTPS:// valide pour votre API (programme ou application).
      Les URL peuvent inclure des ports et des paramètres de requête comme suit :

      • Exemple 1 : https://my-api.com/identityupdatedendpoint
      • Exemple 2 : https://my-api.com:8080/identity-updated-endpoint?my-query-param=123

      Cette URL est utilisée pour transférer la notification d’évènement de point d’ancrage à l’API (programme ou application) tierce correspondante.

      REMARQUE : Votre organisation est chargée de fournir l’URL vers laquelle vous souhaitez que les notifications d’évènements de point d’ancrage soient transférées.
   2. (Facultatif) Saisissez le Code secret (clé d’application) si l’API tierce l’exige.
      Le code secret (la clé d’application) sert à authentifier les communications entre le point d'ancrage ClearID et l’API tierce de votre organisation.
5. (Facultatif) Dans la section En-têtes supplémentaires, remplissez les champs :
   Des en-têtes HTTP personnalisés supplémentaires peuvent être ajoutés à la demande de rappel HTTP afin qu’ils puissent être utilisés par l’API tierce du côté utilisateur de l’intégration.

   REMARQUE : Si vous saisissez un en-tête non valide ou réservé, le message suivant s’affiche L’en-tête de la requête HTTP soumis est incorrect ou mal utilisé.

   
   1. Saisissiez le Nom du paramètre d’en-tête.
      Par exemple, si un événement provient de plusieurs sources, des en-têtes de requêtes HTTP supplémentaires peuvent servir à indiquer la provenance de l’événement (ClearID ou une API externe).
      
   2. Saisissiez la Valeur du paramètre d’en-tête.
   3. (Facultatif) Cliquez sur Ajouter un en-tête pour ajouter des en-têtes de requête HTTP supplémentaires selon les besoins.
      Par exemple, si votre API attend ou requiert un ensemble spécifique d’en-têtes (hôte, origine, langue, et ainsi de suite).
   4. (Facultatif) Cliquez sur pour supprimer les en-têtes qui ne sont plus nécessaires.
6. Dans la section Évènement, configurez les paramètres dont vous avez besoin :
   1. Dans la liste Évènement, sélectionnez un évènement que ce point d’ancrage doit écouter.
   2. Cliquez sur Télécharger le schéma et suivez les invites de votre navigateur.
      BONNE PRATIQUE : Utilisez les informations relatives au schéma téléchargé pour comprendre la structure de données des évènements afin qu’ils puissent être récupérés et traités correctement du côté utilisateur de l’intégration.

      L’exemple suivant montre un extrait d’un fichier schema-identitycreated.json :

      Code

      {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "IdentityDeletedCallbackModel",
        "type": "object",
        "additionalProperties": false,
        "required": [
          "AccountId",
          "IdentityId",
          "DeletedBy",
          "DeletionDateUtc"
        ],
        "properties": {
          "AccountId": {
            "type": "string",
            "description": "The account id for which this identity is member of.",
            "minLength": 1
          },
          "IdentityId": {
            "type": "string",
            "description": "A unique id to identify the identity.",
            "minLength": 1
          },
          "ExternalId": {
            "type": [
              "null",
              "string"
            ],
            "description": "External ID"
          },
          "Ordinal": {
            "type": [
              "integer",
              "null"
            ],
            "description": "Commit ordinal in the storage.",
            "format": "int64"
          },
          "Email": {
            "type": [
              "null",
              "string"
            ],

      
7. Cliquez sur Enregistrer.