Utilizzare l’API di limitazione di utilizzo work

L’API di limitazione di utilizzo consente di creare, configurare e monitorare le configurazioni di limitazione di utilizzo.

Questa sezione fornisce informazioni globali su come lavorare con l’API. Una descrizione API dettagliata è disponibile nella documentazione delle API Adobe Journey Optimizer.

Descrizione API di limitazione

Quando viene creata o aggiornata una configurazione, viene eseguito automaticamente un controllo per garantire la sintassi e l’integrità del payload.
Se si verificano alcuni problemi, l’operazione restituisce un avviso o degli errori per facilitare la correzione della configurazione.

Configurazione endpoint

Di seguito è riportata la struttura di base di una configurazione di endpoint:

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

Esempio:

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

Avvertenze ed errori

Quando viene chiamato un metodo canDeploy, il processo convalida la configurazione e restituisce lo stato di convalida identificato dal relativo ID univoco:

"ok" or "error"

I potenziali errori sono:

Il potenziale avviso è:

ERR_ENDPOINTCONFIG_106: configurazione limite: numero massimo di connessioni HTTP non definite: nessuna limitazione per impostazione predefinita

Casi d’uso

In questa sezione troverai i cinque casi d'uso principali che puoi eseguire per gestire la configurazione dei limiti in Journey Optimizer.

Per facilitare i test e la configurazione, qui è disponibile una raccolta Postman.

Questa raccolta Postman è stata configurata per condividere la raccolta di variabili Postman generata tramite Integrazioni della console di Adobe I/O > Prova > Scarica per Postman, che genera un file di ambiente Postman con i valori delle integrazioni selezionate.

Una volta scaricata e caricata in Postman, è necessario aggiungere tre variabili: {JO_HOST},{BASE_PATH} e {SANDBOX_NAME}.

Nella sezione seguente, è disponibile un elenco ordinato delle chiamate API REST per eseguire il caso d’uso.

Caso d'uso n. 1: Creazione e distribuzione di una nuova configurazione di limite

Caso d'uso n. 2: Aggiornare e distribuire una configurazione di limite non ancora distribuita

Caso d'uso n. 3: Annullamento della distribuzione ed eliminazione di una configurazione di limitazione implementata

Caso d'uso n. 4: Eliminare una configurazione di limitazione distribuita.

È possibile annullare la distribuzione ed eliminare la configurazione in una sola chiamata API utilizzando il parametro forceDelete.

Caso d'uso n. 5: Aggiornamento di una configurazione di limite già distribuita