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 Adobe Journey Optimizer API-documentatie.

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 een canDeploy De 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: config.max. HTTP-verbindingen niet gedefinieerd: standaard geen beperking

Gebruiksscenario's

In deze sectie zult u de vijf belangrijkste gebruik-gevallen vinden die u kunt uitvoeren om uw het capteren configuratie binnen te beheren 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.

Gebruiksscenario n°1: Het creëren en de plaatsing van een nieuwe het maximum configuratie

Gebruiksscenario n°2: Een configuratie voor uitlijnen bijwerken en implementeren die nog niet is geïmplementeerd

Gebruiksscenario n°3: Implementeer en verwijder een geïmplementeerde configuratie voor plafonnering

Gebruiksscenario n°4: Verwijder een configuratie voor geïmplementeerde uiteinden.

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

Gebruiksscenario n°5: Een reeds geïmplementeerde configuratie voor plafonnering bijwerken