Utiliser l’API de plafonnement work

L’API de plafonnement vous permet de créer, configurer et surveiller vos configurations de plafonnement.

Cette section fournit des informations générales sur l’utilisation de l’API. Consultez la description détaillée de l’API dans la Documentation des API Adobe Journey Optimizer.

Description de l’API de plafonnement

Lorsqu’une configuration est créée ou mise à jour, une vérification est automatiquement effectuée pour garantir la syntaxe et l’intégrité de la payload.
Si certains problèmes se produisent, l’opération renvoie un avertissement ou des erreurs pour vous aider à corriger la configuration.

Configuration du point d’entrée

Voici la structure de base d’une configuration de point d’entrée :

{
    "url": "<endpoint URL>",  //wildcards are allowed in the endpoint URL
    "methods": [ "<HTTP method such as GET, POST, >, ...],
    "services": {
        "<service name>": { . //must be "action" or "dataSource"
            "maxHttpConnections": <max connections count to the endpoint (optional)>
            "rating": {
                "maxCallsCount": <max calls to be performed in the period defined by period/timeUnit>,
                "periodInMs": <integer value greater than 0>
            }
        },
        ...
    }
}

Exemple :

`{
  "url": "https://api.example.org/data/2.5/*",
  "methods": [
    "GET"
  ],
  "services": {
    "dataSource": {
      "rating": {
        "maxCallsCount": 500,
        "periodInMs": 1000
      }
    }
  }
}

Avertissement et erreurs

Lorsqu’une méthode canDeploy est appelée, le processus valide la configuration et renvoie le statut de validation identifié par son identifiant unique, au choix :

"ok" or "error"

Les erreurs potentielles sont les suivantes :

L’avertissement potentiel est :

ERR_ENDPOINTCONFIG_106: capping config: max HTTP connections not defined: no limitation by default

Cas d’utilisation

Cette section décrit les cinq principaux cas d’utilisation que vous pouvez mettre en œuvre pour gérer la configuration des limitations dans Journey Optimizer.

Pour vous aider dans les tests et la configuration, une collection Postman est disponible ici.

Elle a été créée pour partager la collection de variables Postman générée par le biais des options Intégrations de la console Adobe I/O > Essayez-la > Télécharger pour Postman, qui génère un fichier d’environnement Postman contenant les valeurs d’intégration sélectionnées.

Une fois le téléchargement puis le chargement effectués dans Postman, vous devez ajouter trois variables : {JO_HOST}, {BASE_PATH} et {SANDBOX_NAME}.

Dans la section suivante, vous trouverez la liste classée des appels API REST pour effectuer le cas d’utilisation.

Cas d’utilisation n°1 : création et déploiement d’une nouvelle configuration de limitation

Cas d’utilisation n°2 : mise à jour et déploiement d’une configuration de limitation non encore déployée

Cas d’utilisation n°3 : annulation du déploiement et suppression d’une configuration de limitation déployée

Cas d’utilisation n°4 : suppression d’une configuration de limitation déployée

En un seul appel d’API, vous pouvez annuler le déploiement et supprimer la configuration à l’aide du paramètre forceDelete.

Cas d’utilisation n°5 : mise à jour d’une configuration de limitation déjà déployée