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 e raccolta Postman description

Nella tabella seguente sono elencati i comandi disponibili per l’API di limitazione di utilizzo. Informazioni dettagliate, inclusi esempi di richieste, parametri e formati di risposta, sono disponibili nella documentazione delle API di Adobe Journey Optimizer.

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.

Inoltre, una raccolta Postman è disponibile qui per aiutarti nella configurazione di test.

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

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

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 sono elencati i casi d'uso chiave per la gestione delle configurazioni di limitazione di utilizzo in Journey Optimizer e i comandi API associati necessari per implementare il caso d'uso.

I dettagli su ciascun comando API sono disponibili nella descrizione API e raccolta Postman.