L’API de limitation vous permet de créer, de configurer et de suivre vos configurations de limitation.
Méthode | Chemin | Description |
---|---|---|
POST | list/endpointConfigs | Obtention d’une liste des configurations de limitation des points d’entrée |
POST | /endpointConfigs | Création d’une configuration de limitation des points d’entrée |
POST | /endpointConfigs/{uid} /deploy |
Déploiement d’une configuration de limitation des points d’entrée |
POST | /endpointConfigs/{uid} /undeploy |
Annulation du déploiement d’une configuration de limitation des points d’entrée |
POST | /endpointConfigs/{uid} /canDeploy |
Vé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.
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>
"rating": {
"maxCallsCount": <max calls to be performed in the period defined by period/timeUnit>,
"periodInMs": <integer value greater than 0>
}
},
...
}
}
`{
"url": "https://api.example.org/data/2.5/*",
"methods": [
"GET"
],
"services": {
"dataSource": {
"maxHttpConnections": 30000,
"rating": {
"maxCallsCount": 5000,
"periodInMs": 1000
}
}
},
"orgId": "<IMS Org Id>"
}
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 :
<!--<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
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 Orchestration.
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}
.
{JO_HOST}
: URL de passerelle Journey Orchestration{BASE_PATH}
: point d’entrée pour l’API. La valeur est '/authoring'{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.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