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.

Beskrivning av API för begränsning

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.

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": {
      "maxHttpConnections": 50,
      "rating": {
        "maxCallsCount": 500,
        "periodInMs": 1000
      }
    }
  },
  "orgId": "<IMS Org Id>"
}

Varningar och fel

När en canDeploy -metod anropas validerar processen konfigurationen och returnerar den verifieringsstatus som identifieras av dess unika ID, antingen:

"ok" or "error"

Möjliga fel är:

Den potentiella varningen är:

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

Användningsfall

I det här avsnittet hittar du de fem huvudsakliga användningsfall som du kan använda för att hantera din appkonfiguration i Journey Orchestration.

Det finns en Postman-samling som kan hjälpa dig med testning och konfiguration här.

Den här Postman-samlingen har konfigurerats för att dela den samling med Postman-variabler som genererats via Integreringar i Adobe I/O Console > Testa > Hämta för Postman, som genererar en Postman-miljöfil med de valda integreringsvärdena.

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

I följande avsnitt hittar du listan över Rest API-anrop ordnade för att utföra fallstudien.

Användningsfall n°1: Skapande och distribution av en ny takkonfiguration

Användningsfall n°2: Uppdatera och distribuera en takkonfiguration som inte har distribuerats än

Användningsfall nr 3: Avdistribuera och ta bort en distribuerad capping-konfiguration

Användningsfall nr 4: Ta bort en distribuerad takkonfiguration.

I endast ett API-anrop kan du avbryta driftsättning och radera konfigurationen med hjälp av parametern forceDelete.

Användningsfall nr 5: Uppdatera en takkonfiguration som redan distribuerats