16.09 - Notas da versão do Edge for Private Cloud

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Em 19 de setembro de 2016, lançamos uma nova versão do Apigee Edge para nuvem privada.

Desde a versão de recursos anterior do Edge para nuvem privada, as seguintes versões foram lançadas e estão incluídas nesta versão de recursos:

• Cloud: 16.04.13 (UI), 16.04.13 (monetização), 16.04.20 (UI), 16.04.27 (monetização), 16.04.27 (UI), 16.05.04 (UI), 16.05.11 (UI), 16.05.11 (monetização), 16.05.18 (UI), 16.05.25 (monetização), 16.06.08 (monetização), 16.06.15 (UI), 16.06.22 (monetização), 16.06.29 (UI), 16.07.06 (monetização), 16.07.06.02 (monetização), 16.07.13 (UI), 16.07.20.01 (monetização), 16.07.27 (UI), 16.08.17

Consulte Sobre a numeração de versões para entender como descobrir se uma versão específica da nuvem está incluída na sua versão do Edge para nuvem privada.

Visão geral da versão

Nesta versão, o editor clássico de proxy de API foi removido e substituído pelo novo editor de proxy, que estava disponível para uso com o editor clássico. Outras melhorias notáveis incluem comportamento aprimorado de caminhos de recursos de produtos de API, melhor tratamento de payloads JSON definidos nas políticas "Atribuir mensagem" e "Gerar falha", melhorias nas conversões de XML para JSON, validação de recursos aprimorada, capacidade de definir tempos limite em proxies de API individuais, geração atualizada de proxies SOAP no assistente de proxy de API e um objeto Crypto de alta performance para JavaScript.

As melhorias na monetização incluem novos recursos de notificação com um plano de taxa de notificação, uma API que migra desenvolvedores para a monetização e a capacidade de tornar os planos de preços públicos ou particulares.

O restante deste tópico contém detalhes sobre todos os novos recursos, atualizações e correções de bugs contidos na versão.

Descontinuado

Serviços da API

Editor de proxy clássico removido (interface do Cloud 16.04.20)

A nova versão do Editor de proxy de API é agora a única compatível. A versão clássica não está mais disponível, e o link "Acessar a versão clássica do Editor de proxy" foi removido. Se você estava usando a versão clássica, seus proxies de API serão carregados automaticamente no novo editor. (EDGEUI-498)

Monetização

Os seguintes recursos descontinuados foram removidos e não são mais aceitos:

• Definir limites
• Notificações de limite de envio

Como alternativa, você pode configurar notificações, conforme descrito nas seções a seguir:

• Configurar notificações de eventos
• Criar uma notificação de limite para um plano de taxas

(DEVRT-2742)

Novos recursos e atualizações

Confira a seguir os novos recursos e melhorias desta versão. Além das melhorias a seguir, esta versão também inclui várias melhorias de usabilidade, desempenho, segurança e estabilidade.

Para mais detalhes e instruções, consulte a documentação do Edge para nuvem privada.

Nuvem privada

Upgrade do PostgreSQL para a versão 9.4

Esta versão inclui um upgrade para o Postgres 9.4. Para instruções sobre como atualizar seu sistema, consulte Atualizar o Apigee Edge para 4.16.09.

Suporte ao GeoMap na interface do Edge

Com as agregações geográficas, você coleta dados de análise de chamadas de API com base em atributos geográficos, como região, continente, país e cidade. Com esses dados de análise, é possível conferir um mapa geográfico na interface do Edge que mostra a localização das solicitações de API.

Para mais informações, consulte Ativar a agregação geográfica e os mapas geográficos.

API BaaS

Adicionamos documentação sobre:

• Como configurar o API BaaS para usar TLS. Para mais informações, consulte Configurar o TLS para o API BaaS.
• Como configurar todos os nós da pilha do API BaaS para usar o armazenamento compartilhado, de modo que todos os recursos estejam disponíveis para todos os nós da pilha do API BaaS. Para mais informações, consulte Como fazer upload de recursos.
• Como criptografar a senha do Cassandra ao configurar nós da BaaS Stack. Para mais informações, consulte Como redefinir senhas do Edge.

Versão Beta da ferramenta e do painel de monitoramento

Esta versão inclui uma versão Beta da nova ferramenta e painel de monitoramento para o Edge. Com essa ferramenta, é possível entender a integridade de vários componentes (roteadores, processadores de mensagens, ZooKeeper, Cassandra) e códigos de erro HTTP de várias organizações e ambientes na sua implantação. Você também pode fazer um instantâneo dos dados do painel e compartilhar com o Apigee para ajudar a resolver incidentes de suporte.

A documentação, incluindo as instruções de instalação, está incluída no documento do Edge 4.16.09 em Versão 4.18.01.

No entanto, antes de instalar e usar o painel, é preciso preencher e enviar por e-mail para orders@apigee.com o Contrato de avaliação da Apigee, também disponível em Versão 4.18.01.

Versão Beta da ferramenta de coleta do Google Analytics

Todos os clientes do Edge para nuvem privada precisam enviar à Apigee estatísticas sobre o tráfego de proxy de API. A Apigee recomenda que os clientes façam upload dessas informações uma vez por dia, possivelmente criando um cron job.

Para ajudar no upload desses dados, a Apigee oferece a versão Beta do utilitário de linha de comando apigee-analytics-collector. Esse utilitário envia o relatório de volume de chamadas de API de volta para a Apigee. Todas as instalações do Edge para nuvem privada podem usar esse utilitário para recuperar e informar dados de tráfego à Apigee.

Para mais informações, consulte Fazer upload de dados de tráfego da API para o Apigee: versão Beta.

Serviços da API

Payloads JSON em "Atribuir mensagem" e "Gerar falha" (Cloud 16.08.17)

Com essa melhoria, não são necessárias soluções alternativas para garantir a formatação adequada das mensagens JSON, e as variáveis podem ser especificadas usando chaves sem criar um JSON inválido. Por exemplo, o comando a seguir insere o valor de message.content na mensagem JSON:

<Payload contentType="application/json">{"Message: " : "{message.content}"}</Payload>

Se você usou uma solução alternativa, seu código vai continuar funcionando como está. Também é possível usar variablePrefix e variableSuffix em vez de chaves para indicar variáveis.

Consulte o elemento <Set><Payload> nos documentos de referência da política Assign Message e da política Raise Fault. (APIRT-1160)

Melhorias na política XML para JSON (Cloud 16.08.17)

A política XML para JSON foi aprimorada com os seguintes recursos. Você pode configurar a política para:

• Tratar alguns elementos XML como matrizes durante a conversão, o que coloca os valores entre colchetes "[ ]" no documento JSON.
• Remova ou elimine níveis da hierarquia do documento XML no documento JSON final.

Para mais informações, consulte Política XML para JSON. (APIRT-1144)

Vários caracteres curinga em caminhos de recursos de produtos de API (Cloud 16.08.17)

Ao definir caminhos de recursos no produto de API, é possível incluir caracteres curinga em vários lugares de um caminho de recurso. Por exemplo, /team/*/invoices/** permite chamadas de API com qualquer valor após /team e qualquer caminho de recurso após invoices/. Um URI permitido em uma chamada de API seria proxyBasePath/team/finance/invoices/company/a.

Se, após esse lançamento, os caminhos de recursos do produto de API pararem de funcionar como esperado, defina a seguinte propriedade na sua organização para reverter ao comportamento anterior: features.enableStandardWildCardMatchForAPIProductResources = true

(MGMT-3273)

Funções criptográficas em JavaScript (Cloud 16.08.17)

Um novo conjunto de funções JavaScript crypto de alta performance está disponível para criar, receber e atualizar os seguintes objetos de hash: MD5, SHA-1, SHA256 e SHA512. O objeto crypto também permite receber a data em vários formatos. Para mais informações, consulte Modelo de objeto JavaScript. (APIRT-2886)

Verificação da versão do JAR de destaque de Java (Cloud 16.08.17)

Ao fazer upload de um recurso JAR Java para um proxy de API, um código de status HTTP 400 será retornado (em vez de 500) se a versão do recurso Java for incompatível com a versão do Java compatível com o Edge, listada em Software e versões compatíveis. (MGMT-3420)

Validação de recursos de proxy de API (Cloud 16.08.17)

Quando você tem arquivos de recursos de proxy de API (como JARs JavaScript ou Java) armazenados no escopo do ambiente ou da organização, a estrutura de validação não exige mais que você inclua esses recursos no nível do proxy de API em um pacote de proxy para que a importação passe na validação. A validação de recursos agora ocorre no momento da implantação, e não da importação. (MGMT-1430)

Configurar o tempo limite para proxies de API individuais (Cloud 16.08.17)

É possível configurar proxies de API para expirar após um período especificado (com um status de tempo limite de gateway 504). O principal caso de uso é para clientes do Cloud privado que têm proxies de API que levam mais tempo para serem executados. Por exemplo, digamos que você precise de proxies específicos para expirar em 3 minutos. Você pode usar uma nova propriedade api.timeout na configuração de um proxy de API. Veja como fazer isso com o exemplo de 3 minutos:

1. Primeiro, configure o balanceador de carga, o roteador e o processador de mensagens para expirar após três minutos.
2. Em seguida, configure os proxies relevantes para expirar em três minutos. Especifique o valor em milissegundos. Exemplo:

   <ProxyEndpoint name="default">
     <HTTPProxyConnection>
       <BasePath>/v1/weather</BasePath>
       <Properties>
         <!-- api.timeout is in milliseconeds -->
         <Property name="api.timeout">180000</Property>
       </Properties>
       ...

3. No entanto, aumentar os tempos limite do sistema pode causar problemas de desempenho, porque todos os proxies sem uma configuração api.timeout usam os novos tempos limite maiores do balanceador de carga, do roteador e do processador de mensagens. Assim, configure outros proxies de API que não exigem tempos limite mais longos para usar tempos limite mais baixos. Por exemplo, o comando a seguir define um proxy de API que expira depois de um minuto:
   <Property name="api.timeout">60000</Property>

Os clientes do Cloud, que não podem modificar os tempos limite do Edge, também podem configurar um tempo limite do proxy de API, desde que ele seja menor que o tempo limite padrão do processador de mensagens do Edge de 57 segundos.

Não é possível preencher o valor com uma variável. Essa propriedade está abordada na Referência de propriedades do endpoint. (APIRT-1778)

Comportamento do proxy SOAP ao usar o assistente de proxy (interface do Cloud 16.07.27)

Ao criar um proxy baseado em SOAP de um WSDL usando o assistente de proxy, há duas opções para criação de proxy:

• SOAP de passagem, em que o proxy simplesmente passa um payload de solicitação SOAP como está.
• REST para SOAP para REST, em que o proxy converte um payload de entrada, como JSON, em um payload SOAP e, em seguida, converte a resposta SOAP de volta para o formato esperado pelo chamador.

Esta versão inclui as seguintes atualizações sobre o comportamento dessas opções. As diferenças entre o comportamento antigo e o novo estão nas políticas e configurações geradas automaticamente pelo assistente de proxy.

SOAP de repasse

• Todas as operações WSDL agora são enviadas para o caminho base do proxy "/" em vez de recursos de proxy (como "/cityforecastbyzip"). Os nomes das operações são transmitidos ao serviço SOAP de destino. Esse comportamento corresponde à especificação SOAP.

• O proxy gerado não é mais compatível com JSON na solicitação. Ele é compatível apenas com XML. O proxy garante que as solicitações SOAP tenham um envelope, um corpo e um namespace.

REST para SOAP para REST

• O WSDL 2.0 não é compatível.
• O novo comportamento não foi testado com a WS-Policy.
• O proxy permite POSTar dados JSON em vez de FormParams.
• Ao adicionar suporte ao CORS (compartilhamento de recursos entre origens) ao proxy usando o criador de proxy, você vai notar as seguintes melhorias:
  • Cabeçalho Access-Control-Allow-Headers: além dos cabeçalhos Origin, x-requested-with e Accept, o cabeçalho Access-Control-Allow-Headers também inclui Content-Type, Accept-Encoding, Accept-Language, Host, Pragma, Referrer, User-Agent e Cache-Control.
  • Cabeçalho Access-Control-Allow-Methods: além de GET, PUT, POST e DELETE, esse cabeçalho também inclui os verbos PATCH e OPTIONS.
• Ao gerar um proxy de API para um WSDL, o Edge lê todos os ComplexTypes definidos como abstratos no WSDL e reconhece corretamente todos os tipos de instância baseados nos tipos abstratos.

Utilitário de linha de comando de código aberto wsdl2apigee

A Apigee também oferece um utilitário de linha de comando de código aberto para gerar proxies de API de transferência ou rest-to-soap de WSDLs. Consulte https://github.com/apigee/wsdl2apigee.

(EDGEUI-614)

Padrão de expiração/atualização na política de operações do mapa de chave-valor (interface do Cloud 16.06.15)

Com a política de operações do mapa de chave-valor, você determina por quanto tempo os valores são mantidos antes de serem atualizados. O intervalo de atualização é definido com o elemento <ExpiryTimeInSecs>. Se uma operação GET for executada e o intervalo de expiração tiver sido excedido, o valor será atualizado e a política receberá o valor atualizado. Quando você adiciona essa política a um proxy de API, o tempo de expiração padrão é de 300 segundos. O padrão anterior era -1, o que significa que os valores nunca são atualizados. (EDGEUI-579)

Monetização

Plano de tarifas de taxa de notificação ajustável (IU do Cloud 16.04.20, monetização do Cloud 16.04.13)

Um novo plano de taxas de notificação ajustável na monetização do Edge permite que um provedor de API ajuste o número de transações desejado para cada desenvolvedor de app. É possível configurar se e quando as notificações serão enviadas com base em qual porcentagem da meta foi atingida, como 90%, 100% ou 150%. Esse recurso está disponível na interface de gerenciamento e na API Management, que já estava disponível em uma versão anterior. Para mais informações, consulte Especificar detalhes ajustáveis do plano de notificações. (DEVRT-2375, DEVRT-2370)

Notificações de webhook para planos de taxa de notificação ajustáveis (monetização do Cloud 16.04.27)

Para planos de taxa de notificação ajustáveis, é possível criar webhooks que enviam notificações para o URL especificado. Você também pode controlar as notificações para que elas ocorram em intervalos específicos (porcentagens) até que o limite de transações seja atingido. As notificações de webhook oferecem uma alternativa flexível ao uso dos modelos de notificação atuais. Consulte Configurar notificações usando webhooks. (DEVRT-2393, DEVRT-2394)

Plano de tarifas de notificação ajustável com atributo personalizado (interface do Cloud 16.05.18)

Na monetização do Edge, um novo plano de tarifas "Notificação ajustável com atributo personalizado" permite adicionar à contagem de transações de um desenvolvedor usando o valor de um atributo personalizado. Com o plano de taxas padrão de notificação ajustável, cada chamada de API bem-sucedida adiciona 1 à contagem de transações de um desenvolvedor. Mas, com o plano de tarifas de notificação ajustável com atributo personalizado, o valor do atributo personalizado é adicionado à contagem de transações do desenvolvedor. Por exemplo, se o atributo personalizado "small" tiver um valor de 0,1 na resposta, a contagem de transações será incrementada em 0,1. Se o atributo personalizado "addressTotal" tiver um valor de 50, a contagem será incrementada em 50. Para mais informações, consulte Especificar um plano de tarifas com detalhes de atributos personalizados. (DEVRT-2504)

Configurar notificações com base nos totais de transações combinados de uma empresa e seus desenvolvedores (monetização do Cloud 16.06.22)

Normalmente, os totais de transações são rastreados automaticamente para todos os desenvolvedores de uma empresa quando eles usam o app da empresa para acessar APIs. E se você tiver desenvolvedores usando ativamente os próprios apps de desenvolvimento para acessar APIs e precisar acompanhar os totais combinados de transações sem interrupção no tráfego? Você pode adicionar os desenvolvedores a uma empresa e configurar notificações para serem enviadas quando os limites forem atingidos com base nos totais combinados de transações da empresa e dos desenvolvedores. Para mais informações, consulte Configurar notificações com base nos totais combinados de transações de uma empresa e dos desenvolvedores dela. (DEVRT-2643)

Ver e reprocessar notificações (monetização do Cloud 16.06.08)

Como parte do pacote de teste de monetização, é possível visualizar e reprocessar notificações enviadas anteriormente usando a API Management. Para mais informações, consulte Visualizar e reprocessar notificações. (DEVRT-2643)

Monetização de teste (monetização do Cloud 16.05.25)

A monetização oferece um conjunto de APIs que podem ser usadas para testar a execução de webhooks e garantir que as notificações sejam enviadas. Para mais detalhes, consulte Testar a configuração de notificações. (DEVRT-2625)

Migração de desenvolvedores para a monetização (monetização do Cloud 16.05.11)

Uma nova API está disponível para facilitar a migração de desenvolvedores para a monetização. Você pode transferir o uso de transações e cobrar taxas de configuração e recorrentes personalizadas. Além disso, ao aceitar um plano de tarifas publicado, você pode dispensar as taxas de configuração, caso elas já tenham sido cobradas. Para mais informações, consulte Migrar desenvolvedores para a monetização. (DEVRT-2446)

Planos de taxa públicos e privados para o portal do desenvolvedor (monetização do Cloud 16.04.27)

Você pode definir os planos de tarifas como "Público" ou "Privado". Os planos de taxas públicas aparecem no portal do desenvolvedor, mas os particulares não. O padrão para um plano de taxas é "Público". Para mais informações, consulte http://docs.apigee.com/monetization/content/create-rate-plans#public-versus-private-rate-plans. (DEVRT-2445)

Restabelecer desenvolvedores (monetização do Cloud 16.06.08)

A monetização oferece um conjunto de APIs que podem ser usadas para cancelar a suspensão de um desenvolvedor que foi suspenso anteriormente. Um desenvolvedor pode ser suspenso se um limite configurado for atingido. Por exemplo, o número de transações atingiu o limite máximo ou o saldo de uma conta pré-paga foi esgotado. Para mais informações, consulte Remover a suspensão de desenvolvedores. (DEVRT-2641)

Ver o status das transações (monetização do Cloud 16.06.08)

Como parte do pacote de testes de monetização, é possível conferir o status das transações que ocorreram durante um período especificado usando a API Management. Para mais informações, consulte Como ver o status das transações. (DEVRT-2640)

Como incluir atributos personalizados do desenvolvedor em relatórios de receita (monetização do Cloud 16.05.25)

Somente para relatórios de receita, é possível incluir atributos personalizados se eles estiverem definidos para o desenvolvedor. Para mais informações, consulte Incluir atributos personalizados do desenvolvedor em relatórios de receita usando a API. (DEVRT-2447)

Política de gravação de transações e consistência de recursos de produtos de API (interface do Cloud 16.05.18)

Se os caminhos de recursos em uma política de gravação de transações de monetização não corresponderem aos caminhos de recursos definidos no produto de API (por exemplo, se você mudar os caminhos de recursos do produto de API), o ícone da política de gravação de transações na página "Produtos" vai mostrar um símbolo de alerta. Quando você clica no ícone para conferir a política de gravação de transações, um aviso aparece na parte de cima da página. Quando você corrigir os caminhos de recursos na política de gravação de transações, os indicadores de aviso vão desaparecer. (DEVRT-2240)

Bugs corrigidos

Os bugs a seguir foram corrigidos nesta versão. Esta lista é principalmente para usuários que verificam se os tíquetes de suporte foram corrigidos. Ela não foi projetada para fornecer informações detalhadas a todos os usuários.

Edge para nuvem privada

16.08.17

16.07.27 (IU)

16.07.20.01 (monetização)

Esta versão inclui pequenas mudanças no esquema do banco de dados. Não há outras atualizações de software nesta versão.

16.07.13 (interface)

16.07.06.02 (monetização)

16.07.06 (monetização)

16.06.29 (UI)

16/06/2022 (monetização)

Nenhum

16.06.15 (interface)

16.06.08 (monetização)

Nenhum

16.05.25 (monetização)

16.05.18 (IU)

16.05.11 (monetização)

16.05.11 (interface)

16.05.04 (interface)

16.04.27 (interface)

16.04.27 (monetização)

Nenhum

16.04.20 (interface)

16.04.13 (monetização)

Nenhum

16.04.13 (interface)

Problemas conhecidos

Esta versão tem os seguintes problemas conhecidos: