Usando os comandos api

É possível usar os comandos api para obter e listar as APIs em seu serviço Portal do Desenvolvedor .

Efetue login como organização do Provedor:
```
apic login --server management_server --realm provider/identity_provider --username provider_username --password provider_password
```
É possível determinar qual provedor de identidade usar no parâmetro --realm inserindo o comando a seguir para ver uma lista de todos os provedores de identidade disponíveis (não é necessário estar conectado para usar este comando):
```
apic identity-providers:list --scope provider --server platform_api_endpoint_url --fields title,realm
```
Por exemplo,
```
apic identity-providers:list --scope provider --server platform_api_endpoint_url --fields title,realm 
total_results: 2
results:
  - title: API Manager User Registry
    realm: provider/default-idp-2
  - title: Corporate LDAP user registry
    realm: provider/corporate-ldap
```
O valor title deve permitir que você determine qual provedor de identidade usar; será possível, então, copiar o parâmetro --realm correspondente diretamente do valor realm exibido. Para todos os provedores de identidade que o administrador criou após a instalação do API Connect , os nomes são determinados no momento da criação. O Registro do usuário local do API Manager padrão para efetuar login como um membro de uma organização do provedor é default-idp-2.
Para obter detalhes completos do comando apic login , consulte Efetuando login em um servidor de gerenciamento..

Para obter um resumo dos comandos de propósito geral e de seu uso, consulte Comandos da CLI do Portal do Desenvolvedor
Listar as APIs de um site.
Por exemplo,
```
apic --mode portaladmin api:list --org orgid/name --server management_server --catalog catalogid/name
```
- management_server é o URL do ponto de extremidade do servidor de gerenciamento (obrigatório).
- catalogid/name é o ID ou nome do catálogo ao qual o site pertence (obrigatório).
- orgid/name é o ID ou o nome da organização do provedor à qual o catálogo pertence (obrigatório)
- format_type é o formato de saída.. Pode ser json, yaml, go-template=..., go-template-file=.... O padrão é yaml.
Obtenha uma API de um site usando o id ou o name:version.
Por exemplo,
```
apic --mode portaladmin api:get --org orgid/name --server management_server --catalog catalogid/name id/name:version
```
- id/name:version -O ID ou o nome: versão de uma API específica (necessário) Por exemplo, id-of-api-called-example-3 ou example:3.0.0.

Obtenha um documento da API inteiro específico do portal da organização e do catálogo fornecidos usando id ou name:version.

apic --mode portaladmin api:get-document --org orgid/name --server management_server --catalog catalogid/name --format format_type  id/name:version

Por exemplo,

apic --mode portaladmin api:get-document --org ibm --server management_server --catalog portal-test --format yaml  intuiz-api:1.0.0

Inclua um anexo para a sua API dentro do Portal do Desenvolvedor

Por exemplo,

apic --mode portaladmin api:add-attachment -s management_server --org orgid/name --catalog catalogid/name --attachment_name attachment.txt --attachment_description "API documentation" mortgage-management-api:1.0.0 ./attachment.txt
Loading File (Large files may take a while)...

Attachment successfully added to api mortgage-management-api:1.0.0.
  This product now has 4 attachments.

attachment_name é o nome dado ao anexo quando ele é transferido por upload (obrigatório).
attachment_description é a descrição do anexo exibido para os usuários.

Configure um ícone para a sua API em seu Portal do Desenvolvedor

Por exemplo,

apic --mode portaladmin api:set-icon -s management_server --org orgid/name --catalog catalogid/name --icon_description "API icon" mortgage-management-api:1.0.0 ./icon.png
Loading File (Large files may take a while)...

Icon successfully set for api mortgage-management-api:1.0.0

icon_description é a descrição do ícone a ser exibida para os usuários e é usada como um texto alternativo para a imagem (obrigatório)

Inclua uma tag (Categoria) para sua API no Portal do Desenvolvedor.

Por exemplo,

apic --mode portaladmin api:add-tag -s management_server --org orgid/name --catalog catalogid/name --tag_name top_level_element/next_level_element/lower_level_element mortgage-management-api:1.0.0
Successfully set taxonomy tag top_level_element/next_level_element/lower_level_element
  for api mortgage-management-api:1.0.0

tag_name é o nome da tag Por exemplo, top_level_element/next_level_element (obrigatório)