Utiliser l’API de plafonnement

Dernière mise à jour : 1 avril 2025
  • Rubriques :
  • API

Créé pour :

  • Débutant
  • Utilisateur ou utilisatrice

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 limitation et collection Postman

Le tableau ci-dessous répertorie les commandes disponibles pour l’API de limitation. Des informations détaillées, notamment des exemples de requête, des paramètres et des formats de réponse, sont disponibles dans la documentation des API Adobe Journey Optimizer 🔗.

MéthodeCheminDescription
POSTlist/endpointConfigsObtention d’une liste des configurations de limitation des points d’entrée
POST/endpointConfigsCréation d’une configuration de limitation des points d’entrée
POST/endpointConfigs/{uid}/deployDéploiement d’une configuration de limitation des points d’entrée
POST/endpointConfigs/{uid}/undeployAnnulation du déploiement d’une configuration de limitation des points d’entrée
POST/endpointConfigs/{uid}/canDeployVérification de la possibilité de déployer ou non une configuration de limitation des points d’entrée
PUT/endpointConfigs/{uid}Mise à jour de la configuration de limitation des points d’entrée
GET/endpointConfigs/{uid}Récupération d’une configuration de limitation des points d’entrée
DELETE/endpointConfigs/{uid}Suppression d’une configuration de limitation des points d’entrée

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.

En outre, une collection Postman est disponible ici pour vous aider dans votre configuration de test.

Cette collection a été configurée pour partager la collection de variables Postman générée via Intégrations de la console Adobe I/O > Essayer > Télécharger pour Postman, qui génère un fichier d’environnement Postman avec 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}.

  • {JO_HOST} : URL de passerelle Journey Optimizer.
  • {BASE_PATH} : point d’entrée pour l’API.
  • {SANDBOX_NAME} : l’en-tête x-sandbox-name (par exemple, « prod ») correspondant au nom sandbox dans lequel les opérations d’API auront lieu. Pour plus d’informations, consultez la Présentation des sandbox.

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>
            }
        },
        ...
    }
}
IMPORTANT
Le paramètre maxHttpConnections est facultatif. Il vous permet de limiter le nombre de connexions que Journey Optimizer va ouvrir au système externe.
La valeur maximale pouvant être définie est de 400. Si rien n’est spécifié, le système peut s’ouvrir à plusieurs milliers de connexions en fonction de l’échelle dynamique du système.
Lorsque la configuration de limitation est déployée, si aucune valeur « maxHttpConnection » n’a été fournie, une valeur par défaut « maxHttpConnection = -1 » est ajoutée dans la configuration déployée, ce qui signifie que Journey Optimizer utilisera la valeur système par défaut.

Exemple :

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