Exportar e Importar APIs

Introdução

Das Minhas APIs, você pode exportar ou importar uma única API personalizada, serviço OData ou API proxy, ou um grupo de APIs:

• Exportar: Permite que você exporte uma única API ou um grupo de APIs para um arquivo APK.
• Importar: Permite que você importe uma única API ou um grupo de APIs usando um arquivo APK que foi exportado anteriormente no API Manager.

Juntas, as funcionalidades de exportação e importação permitem que você migre APIs para outros ambientes ou organizações, conforme necessário.

Exportar APIs

Ao exportar APIs, você pode exportar uma única API ou um grupo de APIs.

Exportar uma Única API

Você pode exportar uma única API personalizada, serviço OData ou API proxy destes locais:

• Na visualização em ficha em Minhas APIs página, passe o mouse sobre o ficha API, clique em ícone do menu de ações e selecione Exportar:

  

• Na visualização de lista em Minhas APIs página, passe o mouse sobre a linha da API, clique em ícone do menu de ações na coluna Ações e selecione Exportar:

  

• Durante a configuração da API, clique em Exportar na parte inferior da etapa 4:

  

Selecionar Exportar inicia um download da API para um arquivo chamado apis-export.apk.

Exportar um Grupo de APIs

Para exportar um grupo de APIs, clique em Exportar API em Minhas APIs página:

Após clicar em Exportar API, a tela Exportar API é aberta:

• Selecionar ambiente: Use o menu para selecionar o ambiente das APIs a serem exportadas. Você pode digitar qualquer parte do nome do ambiente no menu para filtrar a lista de ambientes. Os resultados do menu são filtrados em tempo real com cada pressionamento de tecla.

• Selecionar APIs: Depois que um ambiente é selecionado, uma lista de todas as APIs dentro desse ambiente é preenchida:

  • Selecionar: Selecione as APIs para exportar. A caixa de seleção na coluna do cabeçalho pode ser usada para adicionar todas as APIs de uma vez.

  • API: Exibe o nome da API. A cor do ícone à esquerda do nome da API indica a categoria do status da API:

    Ícone	Cor	Categoria
    	Verde	A API está publicada.
    	Amarelo	A API é publicada com um rascunho.
    	Open Green	A API é um rascunho.

  • Versão: Exibe a versão da API, conforme inserida durante a configuração da API.

  • Tipo de API: Exibe o tipo de API, seja personalizado (CUSTOM API), OData (ODATA), ou proxy (API PROXY).

• Exportar: Clique para iniciar o download das APIs selecionadas para um arquivo chamado apis-export.apk. Uma caixa de diálogo indica se a exportação foi bem-sucedida e exibe uma lista das APIs exportadas com sucesso:

  

• Cancelar: Clique para cancelar a exportação e retornar para Minhas APIs página.

Importar APIs

Ao importar APIs, você pode selecionar uma ou mais APIs de uma exportação anterior. Arquivo APK a ser importado para outro ambiente.

Para importar APIs, clique em Importar API em Minhas APIs página:

Após clicar em Importar API, siga estas etapas para importar APIs:

• Etapa 1: Selecione APIs e ambiente

• Etapa 2: Selecione as APIs a serem publicadas

Etapa 1: Selecione APIs e Ambiente

• Arquivo de API: Clique em Navegar para navegar até um arquivo APK que foi exportado anteriormente do API Manager.

• Ambiente: Use o menu para selecionar o ambiente para o qual você deseja importar as APIs. Você pode digitar qualquer parte do nome do ambiente no menu para filtrar a lista de ambientes. Os resultados do menu são filtrados em tempo real com cada pressionamento de tecla.

• Selecione API(s) para importar: Selecione as APIs a serem importadas para o ambiente selecionado.

  • Selecionar: Selecione as APIs para importar. A caixa de seleção na coluna do cabeçalho pode ser usada para selecionar todas as APIs de uma vez.

  • API: O nome da API.

    Nota

    Um o ícone de erro é exibido ao lado do nome da API quando a combinação de Nome Público da API e Versão já existe no ambiente de destino. Se uma API com erro for selecionada para importação, o botão Avançar será desabilitado. Para resolver, edite um ou ambos os valores nas configurações adicionais (descritas abaixo).

  • Nome público da API: A Raiz do serviço da URL do serviço da API.

  • Versão: A versão da API.

  • Tipo: O tipo de API, um dos personalizados (CUSTOM API), OData (ODATA), ou proxy (API PROXY).

  • Configurações adicionais: Clique no triângulo de divulgação para visualizar configurações adicionais para a API:

    

    • Nome da API: Exibe o nome atual da API. Use a caixa de texto para alterar o nome da API.

    • Nome público da API: Exibe a Raiz do serviço atual do URL do serviço da API. Use a caixa de texto para alterar o Service Root a ser usado para a API. Esses caracteres especiais são permitidos:

      . _ ~ ( ) $ ; / ? : @ = & ' ! * , + -

    • Versão: Exibe a versão atual da API. Use a caixa de texto para alterar a versão a ser usada para a API.

    • Atribuir funções de usuários: Selecione as funções da organização cujos membros terão acesso à API nas páginas do API Manager listadas abaixo. As funções para escolher são aquelas definidas na aba Funções da página Gerenciamento de usuários.

      Esta configuração determina o acesso a esta API específica a partir destas páginas:

      • Minhas APIs
      • Gerenciador do Portal, incluindo geração de documentação de API
      • Portal
      • Registros da API
      • Análise

      Acesso aos Perfis de Segurança página e o acesso para consumir a API não são afetados por esta seleção. (O acesso para consumir uma API é controlado por perfis de segurança.)

      Quaisquer funções de usuário definidas com a permissão Admin sempre têm acesso total a todas as APIs e, portanto, não podem ser desmarcadas da seleção. (Na captura de tela de exemplo mostrada acima, a papel Administrator não pode ser desmarcada por esse motivo.)

    • Atribuir perfil de segurança: Opcionalmente, use o menu para selecionar um perfil de segurança existente que será usado para restringir o acesso para consumo da API. Você pode digitar qualquer parte do nome do perfil de segurança no menu para filtrar a lista de perfis de segurança. Os resultados do menu são filtrados em tempo real a cada pressionamento de tecla. Se nenhum perfil de segurança for selecionado, a autenticação anônima será usada. Pode ser necessário atribuir um perfil de segurança para salvar a API, dependendo das políticas da organização Harmony.

      Nota

      Ao importar uma API, apenas um único perfil de segurança pode ser atribuído a essa API. Depois que a API for importada, você poderá editá API para atribuir perfis de segurança adicionais.

      • Criar novo perfil: Clique para abrir a tela de configuração do perfil de segurança. Depois que o novo perfil for criado, ele estará disponível para ser selecionado no menu Atribuir Perfil de Segurança.

• Próximo: Depois que uma API for selecionada para ser importada, clique no botão botão próximo para ir para a próxima tela.

• Cancelar: Clique para retornar para Minhas APIs página.

• Importar: Este botão fica desabilitado até Etapa 2: Selecionar APIs a serem publicadas está concluído.

Etapa 2: Selecione as APIs a Serem Publicadas

• Arquivo API: Este campo é desabilitado nesta etapa da configuração. Para fazer alterações, retorne para etapa 1 da configuração.

• Ambiente: Este campo está desabilitado nesta etapa nesta etapa da configuração. Para fazer alterações, retorne para etapa 1 da configuração.

• Selecione APIs para publicar: As APIs selecionadas anteriormente para serem importadas são exibidas:

  • Selecionar: Opcionalmente, selecione as APIs a serem publicadas quando importadas. APIs não selecionadas são salvas como APIs de rascunho. A caixa de seleção na coluna de cabeçalho pode ser usada para selecionar todas as APIs de uma vez. Conforme as APIs são selecionadas, os valores em URLs usadas são atualizados adequadamente.

  • Nome público da API: O nome da API.

  • Versão: A versão da API, conforme inserida durante a configuração da API.

  • Tipo: O tipo de API, um dos personalizados (CUSTOM API), OData (ODATA), ou proxy (API PROXY).

• URLs usadas: O número de URLs de API publicadas que serão contabilizadas na sua franquia de assinatura do Harmony assim que a importação for concluída.

  • API: Reflete o número de URLs de API que estarão em uso (após a importação ser concluída) do número total de URLs de API permitidas pela assinatura da organização. As URLs de API usadas atualmente consistem naquelas usadas por APIs de serviço OData e personalizadas publicadas e seus clones publicados. As APIs de rascunho não contam como URLs de API em uso.

  • Proxy: Reflete o número de URLs de API de proxy que estarão em uso (após a importação ser concluída) do número total de URLs de API de proxy permitidas pela assinatura da organização. As URLs de API de proxy usadas atualmente consistem naquelas usadas por APIs de proxy publicadas e seus clones publicados. As APIs de rascunho não contam como URLs de API de proxy em uso.

• Voltar: Clique no botão voltar para retornar ao passo 1 da configuração.

• Cancelar: Clique para retornar para Minhas APIs página.

• Importar: Clique para importar as APIs.

Ao clicar em Importar, uma mensagem indica que as APIs foram importadas com sucesso:

Se os projetos, operações e entidades associados estiverem ausentes do ambiente de destino, uma mensagem de erro será exibida:

• Descartar: Clique para retornar para Minhas APIs página.