Configurer des notifications à l'aide de webhooks

Vous consultez la documentation Apigee Edge.
Accédez à la documentation**Apigee X**. info

Qu'est-ce qu'un webhook ?

Un webhook définit un gestionnaire de rappel HTTP qui est déclenché par un événement. Vous pouvez créer des webhooks et les configurer pour gérer les notifications d'événements, au lieu d'utiliser les modèles de notification de monétisation, comme décrit dans Configurer des notifications à l'aide de modèles de notification.

Pour configurer des notifications à l'aide de webhooks, procédez comme suit à l'aide de l'interface utilisateur de gestion Edge ou de l'API de gestion et de monétisation :

1. Ajoutez des webhooks qui définissent les gestionnaires de rappel pour les événements de notification à l'aide de l ’interface utilisateur ou de l'API.
2. Configurez le gestionnaire de rappel.
3. Configurez la notification pour un plan tarifaire ajustable à l'aide de l' interface utilisateur ou de l'API.

Gérer les webhooks

Ajoutez et gérez des webhooks qui définissent les gestionnaires de rappel pour les événements de notification à l'aide de l' interface utilisateur ou de l'API.

Gérer les webhooks à l'aide de l'interface utilisateur

Ajoutez et gérez des webhooks qui définissent les gestionnaires de rappel pour les événements de notification à l'aide de l'interface utilisateur, comme décrit dans les sections suivantes.

• Explorer la page "Webhooks"
• Ajouter un webhook à l'aide de l'interface utilisateur
• Modifier un webhook à l'aide de l'interface utilisateur
• Supprimer un webhook à l'aide de l'interface utilisateur

Explorer la page "Webhooks"

Accédez à la page "Webhooks", comme décrit ci-dessous.

Ajouter un webhook à l'aide de l'interface utilisateur

Pour ajouter un webhook à l'aide de l'interface utilisateur :

1. Accédez à la page "Webhooks".
2. Cliquez sur + Webhook.
3. Saisissez les informations suivantes (tous les champs sont obligatoires).
   

   Champ	Description
   Nom	Nom du webhook.
   URL	URL du gestionnaire de rappel qui sera appelé lorsque la notification d'événement sera déclenchée. Consultez Configurer le gestionnaire de rappel.

4. Cliquez sur Enregistrer.

Le webhook est ajouté à la liste et activé par défaut.

Modifier un webhook à l'aide de l'interface utilisateur

Pour modifier un webhook à l'aide de l'interface utilisateur :

1. Accédez à la page "Webhooks".
2. Placez le curseur sur le webhook que vous souhaitez modifier, puis cliquez sur dans le menu d'actions.
3. Modifiez les champs du webhook selon vos besoins.
4. Cliquez sur Mettre à jour le webhook.

Activer ou désactiver un webhook à l'aide de l'interface utilisateur

Pour activer ou désactiver un webhook à l'aide de l'interface utilisateur :

1. Accédez à la page "Webhooks".
2. Placez le curseur sur le webhook et activez ou désactivez le bouton d'état.

Supprimer un webhook à l'aide de l'interface utilisateur

Pour supprimer un webhook à l'aide de l'interface utilisateur :

1. Accédez à la page "Webhooks".
2. Placez le curseur sur le webhook que vous souhaitez supprimer, puis cliquez sur .

Le webhook est supprimé de la liste.

Gérer les webhooks à l'aide de l'API

Ajoutez et gérez des webhooks à l'aide de l'API, comme décrit dans les sections suivantes.

• Afficher tous les webhooks à l'aide de l'API
• Afficher un webhook à l'aide de l'API
• Ajouter un webhook à l'aide de l'API
• Modifier un webhook à l'aide de l'API
• Supprimer un webhook à l'aide de l'API

Afficher tous les webhooks à l'aide de l' API

Affichez tous les webhooks en envoyant une requête GET à /mint/organizations/{org_name}/webhooks. Exemple :

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/webhooks" \
  -H "Content-Type: application/json " \
  -u email:password

Voici un exemple de réponse renvoyée :

{
  "totalRecords": 2,
  "webhooks": [
    {
      "created": 1460162656342,
      "enabled": false,
      "id": "21844a37-d26d-476c-93ed-38f3a4b24691",
      "name": "webhook1",
      "postUrl": "http://mycompany.com/callbackhandler1",
      "updated": 1460162656342,
      "updatedBy": "joe@example.com"
    },
        {
      "created": 1460138724352,
      "createdBy": "joe@example.com",
      "enabled": true,
      "id": "a39ca777-1861-49cf-a397-c9e92ab3c09f",
      "name": "webhook2",
      "postUrl": "http://mycompany.com/callbackhandler2",
      "updated": 1460138724352,
      "updatedBy": "joe@example.com"
    }

  ]
}

Afficher un webhook à l'aide de l' API

Affichez un seul webhook en envoyant une requête GET à /mint/organizations/{org_name}/webhooks/{webhook_id}.

Exemple :

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/webhooks/21844a37-d26d-476c-93ed-38f3a4b24691" \
  -H "Content-Type: application/json " \
  -u email:password

Voici un exemple de réponse :

{
   "created": 1460162656342,
   "enabled": false,
   "id": "21844a37-d26d-476c-93ed-38f3a4b24691",
   "name": "webhook1",
   "postUrl": "http://mycompany.com/callbackhandler1",
   "updated": 1460162656342,
   "updatedBy": "joe@example.com"
 }

Ajouter un webhook à l'aide de l' API

Ajoutez un webhook en envoyant une requête POST à /mint/organizations/{org_name}/webhooks. Vous devez transmettre le nom du webhook et l'URL du gestionnaire de rappel qui sera appelé lorsque la notification d'événement sera déclenchée.

Par exemple, la commande suivante crée un webhook nommé webhook3 et attribue callbackhandler3 au webhook :

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/webhooks"
  -H "Content-Type: application/json "
  -d '{
    "name": "webhook3",
    "postURL": "http://mycompany.com/callbackhandler3"
    }' \
    -u email:password

Voici un exemple de réponse :

{
  "created": 1460385534555,
  "createdBy": "joe@example.com",
  "enabled": false,
  "id": "0a07eb1f-f485-4539-8beb-01be449699b3",
  "name": "webhook3",
  "orgId": "myorg",
  "postUrl": "http://mycompany.com/callbackhandler3",
  "updated": 1460385534555,
  "updatedBy": "joe@example.com"
}

Modifier un webhook à l'aide de l'API

Modifiez un webhook en envoyant une requête PUT à /mint/organizations/{org_name}/webhooks/{webhook_id}. Transmettez les mises à jour dans le corps de la requête.

Par exemple, la commande suivante met à jour le gestionnaire de rappel associé à webhook1 :

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/webhooks/0a07eb1f-f485-4539-8beb-01be449699b3" \
  -H "Content-Type: application/json " \
  -d '{
    "postURL": "http://mycompany.com/callbackhandler4"
  }' \
  -u email:password

Voici un exemple de réponse :

{
  "created": 1460385534555,
  "enabled": false,
  "id": "0a07eb1f-f485-4539-8beb-01be449699b3",
  "name": "webhook3",
  "orgId": "myorg",
  "postUrl": "http://mycompany.com/callbackhandler4",
  "updated": 1460385534555,
  "updatedBy": "joe@example.com"
}

Activer ou désactiver un webhook à l'aide de l'API

Activez ou désactivez un webhook en envoyant une requête POST à /mint/organizations/{org_name}/webhooks/{webhook_id}, comme vous l'avez fait lors de la mise à jour d'un webhook, et définissez l'attribut "enabled" dans le corps de la requête sur "true" ou "false", respectivement. Si vous désactivez le webhook, il ne sera pas déclenché lorsqu' un événement se produira.

Par exemple, la commande suivante active webhook3 :

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/webhooks/0a07eb1f-f485-4539-8beb-01be449699b3" \
  -H "Content-Type: application/json " \
  -d '{
    "enabled": "true"
  }' \
  -u email:password

Voici un exemple de réponse :

{
  "created": 1460385534555,
  "enabled": true,
  "id": "0a07eb1f-f485-4539-8beb-01be449699b3",
  "name": "webhook3",
  "orgId": "myorg",
  "postUrl": "http://mycompany.com/callbackhandler4",
  "updated": 1460385534555,
  "updatedBy": "joe@example.com"
}

Supprimer un webhook à l'aide de l' API

Supprimez un webhook en envoyant une requête DELETE à /mint/organizations/{org_name}/webhooks/{webhook_id}.

Pour spécifier si la suppression du webhook doit être forcée ou non si des processus sont en cours, définissez le paramètre de requête forceDelete sur true ou false. Le paramètre de requête forceDelete est activé (true) par défaut.

Par exemple, la commande suivante supprime webhook3 :

curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/webhooks/21844a37-d26d-476c-93ed-38f3a4b24691" \
  -H "Content-Type: application/json " \
  -u email:password

Configurer le gestionnaire de rappel

L'exemple suivant montre le format de la requête JSON envoyée au gestionnaire de rappel défini par un webhook lorsqu'une notification d'événement est déclenchée. Vous devez vous assurer que le gestionnaire de rappel traite la requête de manière appropriée.

{
        "orgName": "{org_id}",
        "developerEmail": "{dev_email}",
        "developerFirstName": "{first_name}",
        "developerLastName": "{last_name}",
        "companyName": "{company_name}",
        "applicationName": "{app_name}",
        "packageName": "{api_package_name}",
        "packageId": "{api_package_id}",
        "ratePlanId": "{rateplan_id}",
        "ratePlanName": "{rateplan_name}",
        "ratePlanType": "{rateplan_type}",
        "developerRatePlanQuotaTarget": {quota_target},
        "quotaPercentUsed": {percentage_quota_used},
        "ratePlanStartDate": {rateplan_startdate}, 
        "ratePlanEndDate": {rateplan_enddate},
        "nextBillingCycleStartDate": {next_billing_cycle_startdate},
        "products": ["{api_product_name}","{api_product_name}"],
        "developerCustomAttributes": [],
        "triggerTime": {trigger_time},
        "triggerReason": "{trigger_reason}",
        "developerQuotaResetDate": "{devquota_resetdate}"
}

Configurer des notifications pour un plan tarifaire ajustable

Configurez des notifications à l'aide de webhooks pour un plan tarifaire ajustable à l'aide de l' interface utilisateur ou de l'API.

Configurer des notifications pour un plan tarifaire ajustable à l'aide de l'interface utilisateur

Configurez des notifications à l'aide de webhooks pour un plan tarifaire ajustable à l'aide de l'interface utilisateur, comme décrit ci-dessous.

Accéder à la boîte de dialogue "Notifications" pour un plan tarifaire ajustable

Accédez à la boîte de dialogue "Notifications" pour un plan tarifaire ajustable, comme décrit ci-dessous.

Ajouter des notifications pour un plan tarifaire ajustable à l'aide de l'interface utilisateur

Pour ajouter des notifications pour un plan tarifaire ajustable à l'aide de l'interface utilisateur :

1. Accédez à la boîte de dialogue Notifications.
2. Définissez la condition de notification sous Intervalles de notification en spécifiant un pourcentage du nombre cible de transactions à partir duquel vous souhaitez qu'une notification soit déclenchée. Plus précisément :
   • Pour définir un pourcentage exact, saisissez-le dans le champ À/De % et laissez le champ À % vide.
   • Pour définir une plage de pourcentage, saisissez le pourcentage de début et de fin dans les champs À/De % et À %, respectivement, et une valeur d'incrément dans le champ Étape %. Par défaut, les notifications sont envoyées par incréments de 10 % dans la plage spécifiée.

   Le champ Notify At est mis à jour pour refléter chaque pourcentage du nombre cible de transactions qui déclenchera un événement.

3. Pour définir des conditions de notification supplémentaires, cliquez sur +Ajouter et répétez l'étape 4.
4. Définissez l'action de notification sous Webhooks en sélectionnant un ou plusieurs webhooks pour gérer le traitement des rappels lorsque des notifications sont déclenchées.
5. Cliquez sur Créer une notification.

Modifier des notifications pour un plan tarifaire ajustable à l'aide de l'interface utilisateur

Pour modifier des notifications pour un plan tarifaire ajustable à l'aide de l'interface utilisateur :

1. Accédez à la boîte de dialogue Notifications.
2. Cliquez sur +Notifier dans la colonne "Actions" du plan tarifaire.
3. Cliquez sur Modifier.
4. Modifiez les valeurs selon vos besoins.
5. Cliquez sur Enregistrer la notification.

Supprimer des notifications pour un plan tarifaire ajustable à l'aide de l'interface utilisateur

Pour supprimer une condition et une action de notification :

1. Accédez à la boîte de dialogue Notifications.
2. Cliquez sur +Notifier dans la colonne "Actions" du plan tarifaire.
3. Cliquez sur Supprimer la notification.

Configurer des notifications pour un plan tarifaire ajustable à l'aide de l' API

Pour configurer une notification pour un plan tarifaire ajustable à l'aide de l'API, suivez la procédure décrite dans Gérer les conditions et les actions de notification à l'aide de l'API et utilisez les attributs décrits dans cette section.

Pour configurer la condition de notification (notificationCondition), utilisez les valeurs d'attribut suivantes. Pour en savoir plus, consultez Configuration propriétés pour les conditions de notification.

Pour configurer l'action de notification, définissez les valeurs suivantes sous actions. Pour en savoir plus, consultez Propriétés de configuration pour les actions de notification.

L'exemple suivant montre comment créer une condition de notification qui déclenche un webhook lorsque le pourcentage du nombre cible de transactions atteint 80%, 90%, 100%, 110%, et 120%.

{
    "notificationCondition": [
      {
        "attribute": "RATEPLAN",
        "value": "123456"
      },
      {
        "attribute": "PUBLISHED",
        "value": "TRUE"
      },
      {
        "attribute": "UsageTarget",
        "value": "%= 80 to 120 by 10"
      }
    } 
    ],
   "actions": [{
          "actionAttribute": "WEBHOOK",
          "value": "b0d77596-142e-4606-ae2d-f55c3c6bfebe",
        }]
  }

Pour savoir comment afficher, mettre à jour et supprimer une condition et une action de notification, consultez les sections suivantes :

• Afficher une condition et une action de notification à l'aide de l'API
• Modifier une condition et une action de notification à l'aide de l'API
• Supprimer une condition et une action de notification à l'aide de l'API

Codes de réponse du webhook

Le tableau suivant récapitule les codes de réponse du webhook et leur interprétation par le système.