Exportar e importar APIs no Jitterbit API Manager

Introdução

Na página de APIs, é possível exportar ou importar APIs para migrá-las para outros ambientes ou organizações conforme necessário. É possível trabalhar com uma única API personalizada, API OData ou API proxy, ou com um grupo de APIs.

Exportar APIs

É possível exportar APIs individualmente ou em grupos para migrá-las para outros ambientes ou organizações.

Exportar uma única API

Escolha o método de exportação com base na sua visualização atual:

• Visualização em lista: Passe o mouse sobre a coluna Ações da API e clique em Exportar.
• Visualização em bloco: Clique no menu de ações e selecione Exportar.

Selecionar Exportar baixa a API para um arquivo chamado apis-export.apk.

Exportar múltiplas APIs

Para exportar múltiplas APIs, clique em Exportar na página de APIs para abrir a tela de configuração.

Configure as seguintes definições para exportar um grupo de APIs:

• 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 a cada tecla pressionada.

• Selecionar APIs: Após selecionar um ambiente, uma lista de todas as APIs dentro desse ambiente será exibida.

  • Selecionar: Selecione as APIs a serem exportadas. Use a caixa de seleção na coluna do cabeçalho para adicionar todas as APIs de uma vez.

  • API: Mostra 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 está publicada com um rascunho.
    	Verde Aberto	A API é um rascunho.

  • Versão: Mostra a versão da API, conforme inserido durante a configuração da API.

  • Tipo de API: Mostra o tipo de API (personalizada, OData ou proxy).

• Exportar: Clique para iniciar o download das APIs selecionadas para um arquivo APK 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 à página APIs.

Importar APIs

Para importar APIs, clique Importar na página APIs.

Etapa 1: Selecionar e configurar APIs

Nesta etapa, você seleciona o arquivo APK, escolhe o ambiente de destino e configura as APIs a serem importadas.

• Arquivo da API: Clique em Procurar para localizar um arquivo APK que você exportou anteriormente do Gerenciador de API.

• Ambiente: Use o menu para selecionar o ambiente no qual 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 a cada tecla pressionada.

Selecionar e configurar APIs para importar

Depois de selecionar um arquivo APK, selecione as APIs a serem importadas para o ambiente selecionado.

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

• API: Mostra o nome da API.

  Nota

  Um ícone de erro aparece 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 você selecionar uma API com erro para importação, o botão Próximo ficará desativado. Para resolver o erro, edite um ou ambos os valores nas configurações adicionais (descritas abaixo).

• Nome Público da API: Mostra a Raiz do Serviço da URL do serviço da API.

• Versão: Mostra a versão da API.

• Tipo: Mostra o tipo de API (personalizada, OData ou proxy).

Configurar configurações adicionais

Clique na seta para visualizar e configurar configurações adicionais para cada API.

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

• Nome Público da API: Mostra a atual Raiz do Serviço da URL do serviço da API. Use a caixa de texto para alterar a Raiz do Serviço a ser utilizada para a API. Os seguintes caracteres especiais são permitidos: . _ ~ ( ) $ ; / ? : @ = & ' ! * , + -

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

• Atribuir Perfil de Segurança: Opcionalmente, use o menu para selecionar um perfil de segurança existente que será utilizado para restringir o acesso ao 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 tecla pressionada. Se nenhum perfil de segurança for selecionado, a autenticação anônima é utilizada. Dependendo das políticas da organização Harmony, pode ser necessário atribuir um perfil de segurança para salvar a API.

  Nota

  Ao importar uma API, você pode atribuir apenas um único perfil de segurança a essa API. Após importar a API, você pode editar a API para atribuir perfis de segurança adicionais.

  • Criar Novo Perfil: Clique para abrir a tela de configuração do perfil de segurança. Após criar o novo perfil, ele ficará disponível no menu Atribuir Perfil de Segurança.

• Próximo: Após selecionar uma API para importar, clique no botão próximo para avançar para a próxima tela.

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

• Importar: Este botão está desativado até que você complete a etapa 2.

Etapa 2: Selecionar APIs para publicar

Nesta etapa, você escolhe quais APIs publicar imediatamente e revisa a contagem de URLs que serão usadas após a conclusão da importação.

• Selecionar: Opcionalmente, selecione as APIs a serem publicadas ao serem importadas. O Gerenciador de APIs salva as APIs não selecionadas como APIs em rascunho. Use a caixa de seleção na coluna de cabeçalho para selecionar todas as APIs de uma vez. À medida que você seleciona APIs, os valores sob URLs usadas são atualizados de acordo.

• Nome Público da API: Mostra o nome da API.

• Versão: Mostra a versão da API, conforme inserido durante a configuração da API.

• Tipo: Mostra o tipo de API (personalizada, OData ou proxy).

• URLs usadas: Mostra o número de URLs de API publicadas que serão contabilizadas contra a sua cota de assinatura do Harmony após a conclusão da importação.

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

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

• Voltar: Clique no botão voltar para retornar à etapa 1.

• Cancelar: Clique para retornar à página de APIs.

• Importar: Clique para importar as APIs selecionadas. Os projetos, operações e entidades de suporte devem existir no ambiente de destino para que as APIs funcionem corretamente.

  Quando você clica em Importar, uma mensagem indica se as APIs foram importadas com sucesso. Se for bem-sucedido, o Gerenciador de APIs publica as APIs selecionadas no novo ambiente, tornando-as imediatamente acessíveis. O Gerenciador de APIs salva as APIs que você não selecionou para publicação como rascunhos no novo ambiente. Essas APIs em rascunho não estão acessíveis no novo ambiente até que você as publique individualmente.

• Dispensar: Clique para retornar à página de APIs.