Use a operação Create consumer app para criar um aplicativo de consumidor em um catálogo especificado para uma organização de consumidores em API Connect.
Criar aplicativo para o consumidor
O create consumer app cria um aplicativo de consumidor no catálogo especificado para uma organização de consumidores específica na instância API Connect. A confirmação do usuário é necessária antes que essa operação seja realizada.
Tabela 1. Parâmetros
| Parâmetro |
Tipo |
Obrigatório |
Descrição |
title |
sequência |
Obrigatório se name não for fornecido. |
O título exibido do aplicativo do consumidor. |
name |
sequência |
Obrigatório se title não for fornecido. |
O nome exclusivo (identificador) do aplicativo do consumidor. |
consumer_org |
sequência |
Obrigatório |
O nome da organização de consumidores sob a qual o aplicativo será criado. |
catalog |
sequência |
Opcional |
O nome do catálogo no qual será criado o aplicativo do consumidor. Se não for especificado, "sandbox" será usado por padrão. |
Você pode usar os prompts a seguir para criar um aplicativo de consumidor:
Tabela 2. Criar um aplicativo para o consumidor
| Ação |
Avisos |
Comandos |
| Criar um aplicativo para o consumidor |
- Criar um aplicativo de consumidor por título (catálogo padrão: sandbox)
create consumer app with the title test app for consumer org test-org
- Criar um aplicativo de consumidor por nome para um catálogo específico, por exemplo, teste
create consumer app with the name test-app for consumer org test-org in catalog test
- Crie um aplicativo de consumidor por nome e título para um catálogo específico, por exemplo, teste
create consumer app with the title test app and the name test-app for consumer org test-org in catalog test
|
- Criar um aplicativo do consumidor por título (catálogo padrão: sandbox)
/create_consumer_app title:test app consumer_org:test-org
- Criar um aplicativo do consumidor por nome para um catálogo específico, por exemplo, teste
/create_consumer_app name:test-app consumer_org:test-org
- Criar um aplicativo de consumidor por nome e título para um catálogo específico, por exemplo, teste
create_consumer_app title:test app name:test app consumer_org:test-org
|
Lista de credenciais do aplicativo do consumidor
Essa ferramenta permite listar as credenciais de um determinado aplicativo e organização de consumidores no catálogo da instância API Connect .
Tabela 3. Parâmetros
| Parâmetro |
Tipo |
Obrigatório |
Descrição |
consumer_app |
sequência |
True |
O nome do aplicativo do consumidor. |
consumer_org |
sequência |
True |
O nome da organização de consumidores. |
catalog |
sequência |
Opcional |
O nome do catálogo de destino. Se não for especificado, Sandbox será usado por padrão. |
Você pode usar os prompts a seguir para criar credenciais de aplicativo de consumidor:
Tabela 4. Listar credenciais de aplicativos de consumo
| Ação |
Avisos |
Comandos |
| Listar a credencial do aplicativo do consumidor |
|
Lista de credenciais de aplicativos do consumidor por título (catálogo padrão: 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
|
Criar assinatura
Você pode criar uma assinatura de um aplicativo de consumidor para um produto ou API em uma organização de consumidores e um catálogo na instância API Connect . A confirmação do usuário é necessária antes que essa operação seja realizada.
Tabela 5. Parâmetros
| Parâmetro |
Tipo |
Obrigatório |
Descrição |
api_name |
sequência |
Obrigatório se product_name não for fornecido. |
O nome da API a ser assinada. |
product_name |
sequência |
Obrigatório se api_name não for fornecido. |
O nome do produto a ser assinado. |
consumer_app |
sequência |
Opcional |
O nome do aplicativo do consumidor. Se não for especificado, e houver apenas um aplicativo consumidor no sistema, esse aplicativo será usado por padrão. |
consumer_org |
sequência |
Opcional |
O nome da organização de consumidores. Se não for especificado, e houver apenas uma organização de consumidores no sistema, essa organização será usada por padrão. |
plan |
sequência |
Opcional |
O nome do plano a ser usado para a assinatura. Se não for especificado, e o produto contiver apenas um plano, esse plano será usado por padrão. |
catalog |
sequência |
Opcional |
O nome do catálogo de destino onde a assinatura é criada. Se não for especificado, "sandbox" será usado por padrão. |
Você pode usar os seguintes prompts para criar uma assinatura:
Tabela 6. Criar assinatura
| Ação |
Avisos |
Comandos |
| Criar assinatura |
- Criar uma assinatura por nome de API (catálogo padrão: sandbox)
create subscription for api sample-api
- Criar uma assinatura por nome de API para um catálogo específico, por exemplo, teste
create subscription for api sample-api to catalog test
- Criar uma assinatura pelo nome do produto em um catálogo específico, por exemplo, teste
create subscription for product sample-product to catalog test
- Criar uma assinatura por nome de API usando um plano específico para um catálogo específico
create subscription for api sample-api using plan default-plan to catalog test
- Criar uma assinatura por nome de API para um aplicativo de consumidor específico e uma organização de consumidor para um catálogo específico
create subscription for api sample-api for consumer app test-app and consumer org test-org in catalog test
|
- Criar uma assinatura por nome de API (catálogo padrão: sandbox)
/create_subscription api_name:sample-api
- Criar uma assinatura por nome de API para um catálogo específico, por exemplo, teste
/create_subscription api_name:sample-api catalog:test
- Criar uma assinatura pelo nome do produto em um catálogo específico, por exemplo, teste
/create_subscription product_name:sample-product catalog:test
- Criar uma assinatura por nome de API usando um plano específico para um catálogo específico
/create_subscription api_name:sample-api plan:default-plan catalog:test
- Criar uma assinatura por nome de API para um aplicativo de consumidor específico e uma organização de consumidor para um catálogo específico
/create_subscription api_name:sample-api consumer_app:test-app consumer_org:test-org catalog:test
|
Assinatura da lista
Você pode listar as assinaturas de um aplicativo na instância API Connect .
Tabela 7. Parâmetros
| Parâmetro |
Tipo |
Obrigatório |
Descrição |
api_name |
sequência |
Opcional |
O nome da API. |
product_name |
sequência |
Opcional |
O nome do produto. |
consumer_app |
sequência |
Opcional |
O nome do aplicativo do consumidor. |
consumer_org |
sequência |
Opcional |
O nome da organização de destino. Se não for especificado, Sandbox será usado por padrão. |
Você pode usar os seguintes prompts para listar as assinaturas:
Tabela 8. Inscrição na lista
| Ação |
Avisos |
Comandos |
| Assinatura da lista |
- Listar assinaturas por nome de API (catálogo padrão: sandbox)
list subscriptions for api sample-api
- Listar assinaturas por nome de API de um catálogo específico, por exemplo, teste
list subscriptions for api sample-api from catalog test
- Listar assinaturas por nome de produto de um catálogo específico, por exemplo, teste
list subscriptions for product sample-api from catalog test
- Listar assinaturas por nome do aplicativo do consumidor e nome da organização do consumidor de um catálogo específico
list subscriptions for consumer app test-app and consumer org test-org from catalog test
|
- Listar assinatura por nome de API (catálogo padrão: sandbox)
/list_subscriptions api_name:sample-api
- Lista de assinaturas por nome de API para um catálogo específico, por exemplo, teste
/list_subscriptions api_name:sample-api catalog:test
- Listar a assinatura pelo nome do produto em um catálogo específico, por exemplo, teste
/list_subscriptions product_name:sample-product catalog:test
- Lista de assinaturas por nome de API usando um plano específico para um catálogo específico
/list_subscriptions consumer_app:test-app consumer_org:test-org catalog:test
|