Werken met de API voor uitsnijden work

op deze pagina: Leer hoe te om Adobe Journey Optimizer Capping API te gebruiken om, eindpunt te creëren te vormen op te stellen op te stellen en te controleren begrenst configuraties die vraag aan externe systemen beperken.

Met de API voor uitsnijden kunt u uw configuraties voor uitlijnen maken, configureren en controleren.

Deze sectie bevat algemene informatie over het werken met de API. Een gedetailleerde API beschrijving is beschikbaar in ​ documentatie van Adobe Journey Optimizer APIs ​.

API-beschrijving van uitlijnen en Postman-verzameling description

In de onderstaande tabel staan de beschikbare opdrachten voor de API voor aftiteling. De gedetailleerde informatie met inbegrip van verzoeksteekproeven, parameters, en antwoordformaten is beschikbaar in de ​ documentatie van Adobe Journey Optimizer APIs ​.

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: configuratie beperken: max. HTTP-verbindingen niet gedefinieerd: geen beperking

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 ​.