Fazer upload e download de integrações

É possível fazer o download das suas integrações como um arquivo JSON e salvá-las no sistema local. Como resultado, toda sua integração está disponível em um arquivo, que pode ser carregado diretamente em outro projeto de integração sem qualquer modificação. O upload de uma integração cria uma nova versão no projeto em que o arquivo é enviado.

A integração total em um formato de arquivo traz as seguintes vantagens:

Você pode copiar sua integração de um projeto para outro sem muito esforço.
Você pode atualizar programaticamente o arquivo de integração para mudanças repetitivas, como renomear tarefas ou modificar dinamicamente os nomes das variáveis.

Fazer o download de uma integração

Para fazer o download de uma integração, siga estas etapas:

Na IU da Apigee, selecione sua organização da Apigee.
Clique em Desenvolver > Integrações.
Selecione uma integração existente. Isso abre a integração na página do editor de integração.
Clique no menu suspenso Versões e selecione a versão que você quer salvar.
Na barra de ferramentas do designer, clique em (menu "Ações") e selecione Download.
O arquivo INTEGRATION_NAME.json é salvo automaticamente na pasta de download padrão do navegador da Web.

Observação: o arquivo JSON baixado terá a estrutura do tipo DownloadIntegrationVersionResponse. Se você modificar o arquivo JSON, verifique se o arquivo modificado segue a estrutura DownloadIntegrationVersionResponse.

Fazer upload de uma integração

Para fazer o upload de uma integração, siga estas etapas:

Na interface da Apigee, selecione sua organização da Apigee.
Clique em Desenvolver > Integrações.
Selecione uma integração existente ou clique em CRIAR INTEGRAÇÃO.
Caso você esteja criando uma nova integração, siga estas etapas:
1. Digite um nome e uma descrição na caixa de diálogo Criar integração.
2. Selecione uma região para a integração.
  Observação: o menu suspenso Regiões lista apenas as regiões provisionadas no projeto do Google Cloud. Para provisionar uma nova região, clique em Ativar região. Consulte Ativar nova região para obter mais informações.
3. Clique em Criar.
Isso abre a integração na página do editor de integração.
Na barra de ferramentas do designer, clique em (menu "Ações") e selecione Fazer upload.
Na caixa de diálogo do navegador de arquivos, selecione o arquivo que você quer enviar e clique em Abrir.
Uma nova versão da integração é criada usando o arquivo enviado.

Fazer o download e o upload usando a API

Use as APIs de integração da Apigee para fazer upload ou download de uma integração.

Fazer download da integração usando a API

Para fazer o download de uma integração, emita uma solicitação GET GET para a seguinte API:

https://integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/products/apigee/integrations/INTEGRATION_NAME/versions/INTEGRATION_VERSION:download

No exemplo a seguir, mostramos como fazer o download de uma versão específica de uma integração:

curl -v -s \
-H "Content-Type: application/json" -H "Authorization: Bearer $TOKEN" \
-H "X-GFE-SSL: yes" \
-X GET "https://integrations.googleapis.com/v1/projects/demo-project/locations/us-east1/products/apigee/integrations/test-integration/versions/0e90d453-5fcf-4aae-b164-2e8344d1ac11:download"

Observação: no exemplo anterior, o número da versão de integração é 0e90d453-5fcf-4aae-b164-2e8344d1ac11. Para ver a versão de integração, abra a versão exigida da integração na IU da Apigee e copie a string do ID exclusivo gerado automaticamente após ../integrations/integration/INTEGRATION_NAME/ do URL.

Para ver mais informações, consulte projects.locations.products.integrations.versions.download.

Fazer upload de integração usando a API

Para fazer upload de uma integração, emita uma solicitação POST para a seguinte API:

  https://integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/products/apigee/integrations/INTEGRATION_NAME/versions/INTEGRATION_VERSION}:upload

No exemplo a seguir, mostramos como fazer o upload de uma integração:

curl -v -s -H "Content-Type: application/json"  -H "Authorization: Bearer $TOKEN"  \
-X POST -d '{"content":
  "{\"name\":\"projects/450954726404/locations/us-east1/products/apigee/integrations/test-workflow/versions/0e90d453-5fcf-4aae-b164-2e8344d1ac11\",
  \"origin\":\"UI\",
  \"snapshotNumber\":\"3\",
  \"updateTime\":\"2022-01-06T04:26:58.137Z\",
  \"lockHolder\":\"abc@test.com\",
  \"createTime\":\"2022-01-06T04:26:42.734Z\",
  \"lastModifierEmail\":\"abc@test.com\",
  \"state\":\"DRAFT\",
  \"triggerConfigs\":[{\"label\":\"API Trigger\",\"startTasks\":[{\"taskId\":\"1\"}],
  \"properties\":{\"Trigger name\":\"rj-test-workflow_API_1\"},\"triggerType\":\"API\",\"triggerNumber\":\"1\",\"triggerId\":\"api_trigger/rj-test-workflow_API_1\"}],\"taskConfigs\":[{\"task\":\"EmailTask\",\"taskId\":\"1\",\"taskExecutionStrategy\":\"WHEN_ALL_SUCCEED\",\"displayName\":\"Send Email\"}]}"}'
  \https://integrations.googleapis.com/v1/projects/apigee-1/locations/us-east1/products/apigee/integrations/test-integration/versions:upload

Para mais informações sobre a API, consulte projects.locations.products.integrations.versions.upload.

Considerações

Ao usar o recurso de upload ou download, considere os seguintes pontos:

O upload de uma integração cria uma nova versão dela. Por exemplo, se você tiver uma integração chamada Apigee-Test na versão 5 e fizer upload de um arquivo de integração na Apigee-Test, uma nova versão 6 será criada para a integração.
Se você não tiver uma integração na qual possa fazer upload de um arquivo, primeiro crie uma nova integração e, em seguida, faça o upload. Nesse caso, a nova integração criada estará na versão 1 e a integração enviada por upload estará na versão 2.
Os detalhes dos perfis de autenticação configurados para uma integração não estarão disponíveis no arquivo transferido por download. Após fazer o upload do arquivo, você precisará reconfigurar os perfis de autenticação na integração enviada.