Utilizzare l'operazione Create consumer app per creare un'applicazione consumer in un catalogo specificato per un'organizzazione consumer in API Connect.
Creare un'applicazione per i consumatori
create consumer app crea un'applicazione consumer nel catalogo specificato per una specifica organizzazione di consumatori nell'istanza API Connect. Prima di eseguire questa operazione è necessaria la conferma dell'utente.
Tabella 1. Parametri
| Parametro |
Tipo |
Obbligatorio |
Descrizione |
title |
stringa |
Richiesto se name non è fornito. |
Il titolo visualizzato dell'applicazione del consumatore. |
name |
stringa |
Richiesto se title non è fornito. |
Il nome univoco (identificatore) dell'applicazione del consumatore. |
consumer_org |
stringa |
Obbligatorio |
Il nome dell'organizzazione di consumatori sotto la quale verrà creata l'applicazione. |
catalog |
stringa |
Facoltativo |
Il nome del catalogo in cui creare l'applicazione consumer. Se non viene specificato, per impostazione predefinita viene utilizzato "sandbox" . |
Per creare un'applicazione consumer si possono utilizzare i seguenti suggerimenti:
Tabella 2. Creare un'applicazione consumer
| Azione |
Prompt |
Comandi |
| Creare un'applicazione per i consumatori |
- Creare un'applicazione consumer per titolo (catalogo predefinito: sandbox)
create consumer app with the title test app for consumer org test-org
- Creare un'applicazione consumer con il nome di un catalogo specifico, ad esempio, test
create consumer app with the name test-app for consumer org test-org in catalog test
- Creare un'applicazione consumer per nome e per titolo a un catalogo specifico, ad esempio, test
create consumer app with the title test app and the name test-app for consumer org test-org in catalog test
|
- Creare un'applicazione consumer per titolo (catalogo predefinito: sandbox)
/create_consumer_app title:test app consumer_org:test-org
- Creare un'applicazione per i consumatori in base al nome di un catalogo specifico, ad esempio, test
/create_consumer_app name:test-app consumer_org:test-org
- Creare un'applicazione consumer con nome e titolo di un catalogo specifico, ad esempio, test
create_consumer_app title:test app name:test app consumer_org:test-org
|
Elenco delle credenziali dell'applicazione del consumatore
Questo strumento consente di elencare le credenziali di un'applicazione e di un'organizzazione di consumatori nel catalogo dell'istanza API Connect .
Tabella 3. Parametri
| Parametro |
Tipo |
Obbligatorio |
Descrizione |
consumer_app |
stringa |
Vero |
Il nome dell'applicazione consumer. |
consumer_org |
stringa |
Vero |
Il nome dell'organizzazione dei consumatori. |
catalog |
stringa |
Facoltativo |
Il nome del catalogo di destinazione. Se non viene specificato, per impostazione predefinita viene utilizzato Sandbox . |
È possibile utilizzare i seguenti prompt per creare le credenziali di un'applicazione consumer:
Tabella 4. Elenco delle credenziali dell'applicazione del consumatore
| Azione |
Prompt |
Comandi |
| Elenco delle credenziali dell'applicazione del consumatore |
|
Elenco delle credenziali dell'applicazione consumer per titolo (catalogo predefinito: sandbox) /list_consumer_app_credentials consumer_name:test-app consumer_org:test-org
/list_consumer_app_credentials consumer_name:test-app consumer_org:test-org catalog:test
|
Crea sottoscrizione
È possibile creare un abbonamento per un'applicazione consumer a un prodotto o a un'API all'interno di un'organizzazione consumer e di un catalogo nell'istanza API Connect . Prima di eseguire questa operazione è necessaria la conferma dell'utente.
Tabella 5. Parametri
| Parametro |
Tipo |
Obbligatorio |
Descrizione |
api_name |
stringa |
Richiesto se product_name non è fornito. |
Il nome dell'API da sottoscrivere. |
product_name |
stringa |
Richiesto se api_name non è fornito. |
Il nome del prodotto da sottoscrivere. |
consumer_app |
stringa |
Facoltativo |
Il nome dell'applicazione consumer. Se non viene specificato, e nel sistema esiste una sola applicazione consumer, questa viene utilizzata per impostazione predefinita. |
consumer_org |
stringa |
Facoltativo |
Il nome dell'organizzazione dei consumatori. Se non viene specificato, e nel sistema esiste una sola organizzazione di consumatori, questa viene utilizzata per impostazione predefinita. |
plan |
stringa |
Facoltativo |
Il nome del piano da utilizzare per l'abbonamento. Se non viene specificato e il prodotto contiene un solo piano, questo viene utilizzato per impostazione predefinita. |
catalog |
stringa |
Facoltativo |
Il nome del catalogo di destinazione in cui viene creata la sottoscrizione. Se non viene specificato, per impostazione predefinita viene utilizzato "sandbox" . |
Per creare un abbonamento si possono utilizzare i seguenti prompt:
Tabella 6. Crea sottoscrizione
| Azione |
Prompt |
Comandi |
| Crea sottoscrizione |
- Creare un abbonamento per nome API (catalogo predefinito: sandbox)
create subscription for api sample-api
- Creare una sottoscrizione per nome API a un catalogo specifico, ad esempio test
create subscription for api sample-api to catalog test
- Creare un abbonamento per il nome del prodotto a un catalogo specifico, ad esempio, test
create subscription for product sample-product to catalog test
- Creare un abbonamento per nome API utilizzando un piano specifico a un catalogo specifico
create subscription for api sample-api using plan default-plan to catalog test
- Creare una sottoscrizione per nome API a un'applicazione consumer specifica e a un'org consumer a un catalogo specifico
create subscription for api sample-api for consumer app test-app and consumer org test-org in catalog test
|
- Creare un abbonamento per nome API (catalogo predefinito: sandbox)
/create_subscription api_name:sample-api
- Creare una sottoscrizione per nome API a un catalogo specifico, ad esempio test
/create_subscription api_name:sample-api catalog:test
- Creare un abbonamento per il nome del prodotto a un catalogo specifico, ad esempio, test
/create_subscription product_name:sample-product catalog:test
- Creare un abbonamento per nome API utilizzando un piano specifico a un catalogo specifico
/create_subscription api_name:sample-api plan:default-plan catalog:test
- Creare una sottoscrizione per nome API a un'applicazione consumer specifica e a un'org consumer a un catalogo specifico
/create_subscription api_name:sample-api consumer_app:test-app consumer_org:test-org catalog:test
|
Iscrizione all'elenco
È possibile elencare le sottoscrizioni di un'applicazione dall'istanza API Connect .
Tabella 7. Parametri
| Parametro |
Tipo |
Obbligatorio |
Descrizione |
api_name |
stringa |
Facoltativo |
Il nome dell'API. |
product_name |
stringa |
Facoltativo |
Il nome del prodotto. |
consumer_app |
stringa |
Facoltativo |
Il nome dell'applicazione consumer. |
consumer_org |
stringa |
Facoltativo |
Il nome dell'organizzazione di destinazione. Se non viene specificato, per impostazione predefinita viene utilizzato Sandbox . |
Per elencare le sottoscrizioni si possono usare i seguenti prompt:
Tabella 8. Iscrizione all'elenco
| Azione |
Prompt |
Comandi |
| Iscrizione all'elenco |
- Elencare le sottoscrizioni per nome API (catalogo predefinito: sandbox)
list subscriptions for api sample-api
- Elencare le sottoscrizioni per nome API da un catalogo specifico, ad esempio, test
list subscriptions for api sample-api from catalog test
- Elencare gli abbonamenti per nome di prodotto da un catalogo specifico, ad esempio, test
list subscriptions for product sample-api from catalog test
- Elencare le sottoscrizioni per nome dell'applicazione del consumatore e nome dell'organizzazione del consumatore da un catalogo specifico
list subscriptions for consumer app test-app and consumer org test-org from catalog test
|
- Elenco delle sottoscrizioni per nome API (catalogo predefinito: sandbox)
/list_subscriptions api_name:sample-api
- Elenco delle sottoscrizioni per nome API a un catalogo specifico, ad esempio, test
/list_subscriptions api_name:sample-api catalog:test
- Elenco delle sottoscrizioni in base al nome del prodotto a un catalogo specifico, ad esempio, test
/list_subscriptions product_name:sample-product catalog:test
- Elenco delle sottoscrizioni per nome API utilizzando un piano specifico per un catalogo specifico
/list_subscriptions consumer_app:test-app consumer_org:test-org catalog:test
|