Work with the Capping API work

The Capping API helps you create, configure and monitor your capping configurations.

This section provides global information on how to work with the API. A detailed API description is available in Adobe Journey Optimizer APIs documentation.

Capping API description & Postman collection description

The table below lists the available commands for the capping API. Detailed information including request samples, parameters, and response formats is available in the Adobe Journey Optimizer APIs documentation.

Wanneer een configuratie wordt gecreeerd of bijgewerkt, automatisch wordt een controle uitgevoerd om de syntaxis en de integriteit van de lading te waarborgen.
Als sommige problemen voorkomen, keert de verrichting waarschuwing of fouten terug om u te helpen de configuratie verbeteren.

Bovendien is een inzameling van Postman beschikbaar ​ hier ​ om u in uw het testen configuratie te helpen.

Deze inzameling is opstelling geweest om de Variabele die inzameling van Postman te delen via de Integraties van de Console van Adobe I/O wordt geproduceerd ​ > probeert het uit > Download voor Postman, die een dossier van het Milieu van Postman met de geselecteerde integratiewaarden produceert.

Nadat u het bestand hebt gedownload en geüpload naar Postman, moet u drie variabelen toevoegen: {JO_HOST} , {BASE_PATH} en {SANDBOX_NAME} .

Eindpuntconfiguratie

Hier is de basisstructuur van een eindpuntconfiguratie:

{
    "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>
            }
        },
        ...
    }
}

Voorbeeld:

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

Waarschuwing en fouten

Wanneer a canDeploy methode wordt geroepen, bevestigt het proces de configuratie en keert de bevestigingsstatus terug die door zijn Unieke identiteitskaart wordt geïdentificeerd, of:

"ok" or "error"

De mogelijke fouten zijn:

De mogelijke waarschuwing is:

ERR_ENDPOINTCONFIG_106: het in kaart brengen van config: maximum de verbindingen van HTTP niet bepaald: geen beperking door gebrek

Gebruiksscenario’s

Deze sectie bevat een overzicht van de belangrijkste gebruiksgevallen voor het beheer van configuraties met begrenzingen in Journey Optimizer en de bijbehorende API-opdrachten die nodig zijn om het gebruiksscenario te implementeren.

De details op elk API bevel zijn beschikbaar in de ​ API beschrijving & inzameling van Postman ​.