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 för begränsning

Metod
Sökväg
Beskrivning
POST
list/endpointConfigs
Hämta en lista över konfigurationer för slutpunktsbegränsning
POST
/endpointConfigs
Skapa en konfiguration för begränsning av slutpunkter
POST
/endpointConfigs/{uid}/deploy
Distribuera en slutpunktskonfiguration
POST
/endpointConfigs/{uid}/undeploy
Avdistribuera en slutpunktskonfiguration
POST
/endpointConfigs/{uid}/canDeploy
Kontrollera om en slutpunktskonfiguration kan distribueras eller inte
PUT
/endpointConfigs/{uid}
Uppdatera en konfiguration för begränsning av slutpunkter
GET
/endpointConfigs/{uid}
Hämta en konfiguration för slutpunktsbegränsning
DELETE
/endpointConfigs/{uid}
Ta bort en ändpunktskonfiguration

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>
            }
        },
        ...
    }
}
IMPORTANT
Parametern maxHttpConnections är valfri. Du kan begränsa antalet anslutningar som Journey Optimizer öppnar till det externa systemet.
Det högsta värdet som kan anges är 400. Om inget anges kan systemet öppna upp till flera tusen anslutningar beroende på systemets dynamiska skalning.
Om inget värde för maxHttpConnection har angetts när konfigurationen för begränsning av socket distribueras läggs standardvärdet för maxHttpConnection = -1 till i den distribuerade konfigurationen, vilket innebär att Journey Optimizer kommer att använda standardsystemvärdet.

Exempel:

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

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:

  • ERR_ENDPOINTCONFIG_100: Konfiguration för begränsning: URL saknas eller är ogiltig
  • ERR_ENDPOINTCONFIG_101: capping-konfiguration: felaktig URL
  • ERR_ENDPOINTCONFIG_102: capping config: felaktig url: jokertecken i url tillåts inte i host:port
  • ERR_ENDPOINTCONFIG_103: capping config: HTTP-metoder saknas
  • ERR_ENDPOINTCONFIG_104: konfiguration för begränsning: ingen anropsklassificering har definierats
  • ERR_ENDPOINTCONFIG_107: capping-konfig: ogiltigt max antal anrop (maxCallCount)
  • ERR_ENDPOINTCONFIG_108: capping config: ogiltigt antal anrop (periodInms)
  • ERR_ENDPOINTCONFIG_111: det går inte att skapa slutpunktskonfigurationen: nyttolasten är ogiltig
  • ERR_ENDPOINTCONFIG_112: Det går inte att skapa slutpunktskonfigurationen: en JSON-nyttolast förväntas
  • ERR_AUTHORING_ENDPOINTCONFIG_1: ogiltigt tjänstnamn <!--<given value>-->: måste vara dataSource eller action

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

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

  • {JO_HOST}: Journey Optimizer Gateway-URL
  • {BASE_PATH} : startpunkt för API.
  • {SANDBOX_NAME}: sidhuvudet x-sandbox-name (till exempel ”produktion”) som motsvarar namnet på sandlådan där API-åtgärderna utförs. Se översikten över sandlådor för mer information.

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

  1. list
  2. create
  3. candeploy
  4. deploy

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

  1. list
  2. get
  3. update
  4. candeploy
  5. deploy

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

  1. list
  2. undeploy
  3. delete

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.

  1. list
  2. radera med parametern forceDelete

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

  1. list
  2. get
  3. update
  4. undeploy
  5. candeploy
  6. deploy
recommendation-more-help
b22c9c5d-9208-48f4-b874-1cefb8df4d76