Werken met de API voor uitsnijden work

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.

Beschrijving van API voor uitlijnen

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.

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

In deze sectie vindt u de vijf hoofdgevallen voor het gebruik die u kunt uitvoeren om uw configuratie voor plafonds te beheren in Journey Optimizer .

Voor hulp bij het testen en configureren is hier een Postman-verzameling beschikbaar.

Deze Postman-verzameling is opgezet om de Postman Variabele verzameling te delen die is gegenereerd via Adobe I/O Console-integraties > Uitproberen > Downloaden voor Postman, wat een Postman-omgevingsbestand genereert met de geselecteerde integratiewaarden.

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

In het volgende gedeelte vindt u de geordende lijst van Rest-API-aanroepen om het gebruiksscenario uit te voeren.

Gebruik-Geval n°1: creatie en plaatsing van een nieuwe het capteren configuratie

Gebruik-Geval n°2: Update en stel een het maximum configuratie op die nog niet wordt opgesteld

Gebruik-Geval n°3: stelt en schrapt een opgestelde het begrenzen configuratie onbruikbaar

Gebruik-Geval n°4: schrap een opgestelde het capteren configuratie.

In slechts één API-oproep kunt u de configuratie deïmplementeren en verwijderen met behulp van de parameter forceDelete.

Gebruik-Geval n°5: werk een het maximum configuratie reeds in werking gesteld bij