Utiliser l’API Capping work
L’API Capping vous permet de créer, configurer et surveiller vos configurations de limitation.
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 description
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.
{uid}/deploy{uid}/undeploy{uid}/canDeploy{uid}{uid}{uid}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 lors de la configuration de test.
Elle a été créée pour partager la collection de variables Postman générée dans Intégrations de la console Adobe I/O > Essayer > 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}.
{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>
}
},
...
}
}
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 :
- ERR_ENDPOINTCONFIG_100: capping config: missing or invalid url
- ERR_ENDPOINTCONFIG_101: capping config: malformed url
- ERR_ENDPOINTCONFIG_102 : configuration de limitation : URL incorrecte : caractère générique dans l’URL non autorisé dans l’hôte:port
- ERR_ENDPOINTCONFIG_103: capping config: missing HTTP methods
- ERR_ENDPOINTCONFIG_104: capping config: no call rating defined
- ERR_ENDPOINTCONFIG_107: capping config: invalid max calls count (maxCallsCount)
- ERR_ENDPOINTCONFIG_108: capping config: invalid max calls count (periodInMs)
- ERR_ENDPOINTCONFIG_111: capping config: can't create endpoint config: invalid payload
- ERR_ENDPOINTCONFIG_112: capping config: can't create endpoint config: expecting a JSON payload
- ERR_AUTHORING_ENDPOINTCONFIG_1: invalid service name
<!--<given value>-->: must be 'dataSource' or 'action'
L’avertissement potentiel est :
ERR_ENDPOINTCONFIG_106: capping config: max HTTP connections not defined: no limitation by default
Cas d’utilisation
Cette section répertorie les principaux cas d’utilisation de la gestion des configurations de limitation dans Journey Optimizer et les commandes API associées requises pour mettre en œuvre le cas d’utilisation.
Des détails sur chaque commande API sont disponibles dans la description de l’API et collection Postman.
Appels API à utiliser :
list: récupère les configurations existantes.create: crée une configuration.candeploy: vérifie que la configuration peut être déployée.deploy: déploie la configuration.
Appels API à utiliser :
list: récupère les configurations existantes.get: récupère les détails d’une configuration spécifique.update: modifie la configuration.candeploy: vérifie l’éligibilité du déploiement.deploy: déploie la configuration.
Appels API à utiliser :
list: récupère les configurations existantes.undeploy: annule le déploiement de la configuration.delete: supprime la configuration.
En un seul appel API, vous pouvez annuler le déploiement et supprimer la configuration à l’aide du paramètre forceDelete.
Appels API à utiliser :
list: récupère les configurations existantes.delete(avec le paramètreforceDelete) : force la suppression d’une configuration déployée en une seule étape.
| note note |
|---|
| NOTE |
| Un redéploiement est nécessaire après la mise à jour d’une configuration déployée. |
Appels API à utiliser :
list: récupère les configurations existantes.get: récupère les détails d’une configuration spécifique.update: modifie la configuration.undeploy: annule le déploiement de la configuration avant d’appliquer les modifications.candeploy: vérifie l’éligibilité du déploiement.deploy: déploie la configuration mise à jour.