Managed Runtime API

Utilizzare Managed Runtime API per controllare le applicazioni distribuite in Managed Runtime di Commerce Cloud. È possibile creare strumenti personalizzati con le stesse funzionalità dell'applicazione web Runtime Admin, ma con funzionalità amministrative e opzioni di configurazione ulteriori.

Managed Runtime API è destinata unicamente a scopi amministrativi. Non effettuare richieste all'API nel codice dello storefront.

In questa guida si presuppone la conoscenza di Managed Runtime e dei concetti correlati, quali progetti, ambienti, bundle e distribuzioni. Per ulteriori informazioni, vedere Panoramica di Managed Runtime.

Il nome del brand Mobify compare ancora nel dominio mobify.com nell'URL di base di Managed Runtime API. Sebbene i nuovi domini Salesforce sostituiranno in futuro il dominio Mobify, il supporto per quest'ultimo rimarrà attivo.

Per effettuare richieste API, è necessario includere una chiave API nell'intestazione Authorization della richiesta HTTP con il valore Bearer {{api_key}}.

Per individuare la chiave API, accedere allo strumento Runtime Admin e passare alla pagina Account Settings (Impostazioni account).

Poiché la chiave API consente agli script di eseguire le operazioni automaticamente, è necessario considerarla come una password.

Ecco un breve tutorial su come utilizzare l'API con esempi di richieste formattate come comandi curl.

Prima di eseguire i comandi, sostituire i segnaposto con i valori effettivi. I segnaposto sono formattati nel seguente modo: {{placeholder}}.

Per la maggior parte delle richieste è necessario sostituire {{project_id}} con l'ID progetto effettivo. Per cercare l'ID progetto, accedere allo strumento Runtime Admin e passare alla pagina delle impostazioni del progetto.

Gli ID progetto possono essere composti da un massimo di 20 caratteri e devono essere univoci per l'organizzazione.

Utilizzo degli ambienti

La prima richiesta a Managed Runtime API restituisce un elenco di tutti gli ambienti (o "target" come vengono definiti nell'API) che appartengono a un progetto:

A questo punto è possibile creare un ambiente denominato staging da utilizzare per esaminare le modifiche prima di distribuirle a production:

Per utilizzare il nuovo ambiente è necessario distribuirvi un bundle.

Di seguito sono riportati i dettagli dell'ambiente staging creato:

Infine, modificare la configurazione proxy per staging:

La modifica della configurazione determina la redistribuzione automatica del bundle corrente per rendere effettive le modifiche.

In caso di problemi con l'utilizzo dell'API, eseguire le seguenti operazioni:

  • Aggiungere l'argomento --fail al comando curl.
  • Controllare la chiave API.
  • Fare clic sull'ID del progetto.

Gli endpoint API funzionano anche in un browser. Accedere allo strumento Runtime Admin, quindi aprire l'endpoint utilizzato direttamente nel browser.

In questa guida sono state illustrate le funzionalità di Managed Runtime API con l'aiuto di alcuni esempi di richiesta. Per ulteriori informazioni, fare riferimento alle specifiche dell'API.