Arbeta med API:t för tak work

Med API:t för att hämta innehåll kan du skapa, konfigurera och övervaka dina appkonfigurationer.

Det här avsnittet innehåller global information om hur du arbetar med API:t. En detaljerad API-beskrivning finns i dokumentationen för Adobe Journey Optimizer API.

Beskrivning av API-begränsning och Postman-samling description

Tabellen nedan visar tillgängliga kommandon för API:t för appning. Detaljerad information, inklusive frågeexempel, parametrar och svarsformat, finns i Adobe Journey Optimizer API:s dokumentation.

När en konfiguration skapas eller uppdateras utförs en kontroll automatiskt för att garantera nyttolastens syntax och integritet.
Om det uppstår problem returneras en varning eller felmeddelanden som hjälper dig att korrigera konfigurationen.

Dessutom finns en Postman-samling här som kan hjälpa dig med testkonfigurationen.

Den här samlingen har konfigurerats för att dela Postman Variable-samlingen som genereras via Adobe I/O Console’s Integrations > Testa > Hämta för Postman, som genererar en Postman-miljöfil med de valda integreringsvärdena.

När du har hämtat och överfört till Postman måste du lägga till tre variabler: {JO_HOST},{BASE_PATH} och {SANDBOX_NAME}.

Konfiguration av slutpunkt

Här är den grundläggande strukturen för en slutpunktskonfiguration:

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

Exempel:

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

Warning and errors

When a canDeploy method is called, the process validates the configuration and returns the validation status identified by its Unique ID, either:

"ok" or "error"

The potential errors are:

The potential warning is:

ERR_ENDPOINTCONFIG_106: capping config: max HTTP connections not defined: no limitation by default

Användningsfall

This section lists key use cases for managing capping configurations in Journey Optimizer and the associated API commands required to implement the use case.

Details on each API command is available in the API description & Postman collection.