Esta página se aplica à Apigee e à Apigee híbrida.
Confira a documentação da Apigee Edge.
Os conceitos a seguir são ideias comuns que têm um significado específico na Apigee.
A
- caminho e recursos básicos da API
- Uma API é composta do caminho base e de um conjunto de recursos, também conhecidos como caminhos de recursos. Para cada API, você define um único URL raiz (também chamado de caminho base e vários caminhos de recursos. Pense em uma API simplesmente como um conjunto de URIs, todos compartilhando um caminho base comum. Para facilitar o gerenciamento das APIs, a Apigee aumenta esses URIs brutos com nomes de exibição e descrições.
- consumidor de API
- Sinônimo de desenvolvedor de apps, que usa as APIs criadas por um provedor de APIs.
- desenvolvedor de API
- Um engenheiro de software em uma organização provedora de APIs que cria APIs. Essas APIs são usadas por desenvolvedores de apps (consumidores de API) para criar apps.
- produto de API
- Uma coleção de recursos de API (URIs) combinada a um plano de serviços e apresentada aos desenvolvedores como um pacote. O produto da API também pode incluir alguns metadados específicos da sua empresa para monitoramento ou análise. É possível gerar receita com um ou mais recursos ao incluí-los em um produto de API, que pode ser inserido em um pacote de API para monetização.
- provedor de API
- Um provedor de APIs cria APIs (usando a Apigee) para os consumidores de API (desenvolvedores de app).
- Proxy de API
- Um proxy que atua como uma fachada para sua API existente. Em vez de chamar a API atual, os desenvolvedores começam a chamar a nova API gerada pela Apigee. Essa fachada separa sua interface pública da API de back-end, protegendo os desenvolvedores das alterações de back-end e permitindo que você inove na borda sem afetar suas equipes de desenvolvimento interno. À medida que você faz alterações no back-end, os desenvolvedores continuam a chamar a mesma API sem interrupções. Em cenários mais avançados, a Apigee permite expor várias interfaces à mesma API, liberando você para personalizar a assinatura de uma API para atender às necessidades de vários nichos de desenvolvedores simultaneamente.
- APIs Apigee
- Os endpoints que podem ser usados para configurar ambientes, organizações, proxies de API e outros serviços híbridos.
- desenvolvedor de apps
- No Edge, os desenvolvedores registram seus apps por meio de um provedor de API, que é como os desenvolvedores de apps recebem as chaves de API necessárias para chamar os proxies de API do provedor.
- apps
- Seus desenvolvedores usam apps para acessar os recursos nos produtos de API. Ao criar um app, você seleciona o produto de API a ser incluído e a Apigee gera uma chave. Cada app tem uma única chave que fornece acesso a vários produtos de API. Os apps permitem que você controle quem pode acessar seus recursos. É possível controlar quem tem acesso aos seus produtos de API revogando e atualizando a chave de um app. Além disso, é possível controlar o acesso a pacotes de recursos revogando ou excluindo o acesso aos produtos em um app.
B
- detalhes do saldo
- Saldo na conta do desenvolvedor com plano pré-pago.
C
- Cassandra
(Somente híbrida da Apigee) O repositório de dados do ambiente de execução que armazena configurações de aplicativos, contadores de cota distribuídos, chaves de API e tokens OAuth para aplicativos em execução no gateway.
Esse é um StatefulSet que consome muitos recursos e precisa estar em um nó de trabalho separado do processador de mensagens.
Para saber mais, consulte Sobre o plano de ambiente de execução.
- infraestrutura (ou plano) de gerenciamento central
- Consulte plano de gerenciamento.
- imagem de contêiner [conteinerizada]
- Consulte a imagem.
- plano de controle
- Consulte plano de gerenciamento.
D
- implantar
Na Apigee, você implanta um proxy de API em um ambiente para torná-lo acessível aos clientes de aplicativos na Internet, publicamente ou de modo privado, dependendo da configuração de rede.
- desenvolvedor
- Um desenvolvedor se refere a um papel que um usuário da Apigee pode desempenhar.
Há dois tipos de desenvolvedores na Apigee:
- Desenvolvedores de proxy de API: criam os proxies de API e aplicam políticas.
- Desenvolvedores de aplicativos: criam aplicativos que consomem proxies de API.
- plano de taxas da categoria do desenvolvedor
- Um plano de taxas que se aplica a todos os desenvolvedores de uma categoria específica e está disponível para compra por todos os desenvolvedores dessa categoria.
- plano de taxas do desenvolvedor
- Um plano de taxas que se aplica a um desenvolvedor específico e está disponível para compra somente por esse desenvolvedor.
E
- ambiente
Um ambiente da Apigee é um ambiente de software isolado, dentro de uma organização, em que você implanta proxies de API. Um ambiente pode ser escalonado para atender às demandas dos proxies implantados nele. É possível criar vários ambientes em uma organização.
- grupo de ambientes
-
Um grupo de ambientes é um conjunto de ambientes da Apigee com um ou mais nomes do host. O nome do host faz parte do URL usado para chamar proxies da API implantados em qualquer ambiente no grupo de ambientes.
- limite explícito
- Consulte limite personalizado.
G
- GCR
- Google Container Repository.
- GKE;
- Google Kubernetes Engine. Um ambiente pronto para produção gerenciado pelo Google para implantar aplicativos em contêineres no Kubernetes. O GKE deixa o Kubernetes pronto para uso eliminando por completo a necessidade de instalação, gerenciamento e operação dos seus próprios clusters Kubernetes.
I
- repositório de imagens
- Um grupo de imagens de contêiner compartilhadas.
- limite implícito
- Um limite, como um limite de saldo pré-pago do desenvolvedor, definido pela monetização.
- controlador de entrada/entrada
- Um aplicativo em contêiner que encaminha o tráfego de fora do cluster para os serviços dentro do cluster.
K
- KMS
- Serviço de gerenciamento de chaves. Armazena, mantém e apresenta chaves e tokens OAuth para criptografar e descriptografar tráfego. A Apigee KMS gerencia chaves para aplicativos, desenvolvedores e produtos de API.
- KVM
- Mapa de chave-valor. Uma coleção personalizada de pares de strings de chave/valor criptografados ou não. Para mais informações, consulte Como usar mapas de chave-valor.
- Máquina de administração do Kubernetes
- A máquina local usada para executar comandos no cluster do Kubernetes. Ela é normalmente uma máquina de área de trabalho com acesso às VMs do Kubernetes.
M
- Plano de gerenciamento
- Os serviços centrais hospedados pelo Google que se comunicam com o plano de ambiente de execução por meio de contas de serviço.
- MART
A API para dados de ambiente de execução interage com o armazenamento de dados local do ambiente de execução (Cassandra). Ele funciona como o provedor de API para a API Apigee pública para acessar e gerenciar dados do ambiente de execução.
O MART é um aplicativo sem estado, assim como os Processadores de mensagens. É um app em contêiner do Kubernetes.
Para saber mais, consulte Sobre o plano de ambiente de execução.
- Nó mestre
- Um termo do Kubernetes para um nó que inclua o apiserver, cloud-controller-manager (CCM), o programador e o kube-controller-manager.
- processador de mensagens
-
(Somente Apigee híbrida) O processador de mensagens avalia uma solicitação recebida, executa todas as políticas da Apigee e chama os sistemas de back-end e outros sistemas para recuperar dados. Depois que essas respostas são recebidas, o processador de mensagens formata uma resposta e a retorna para o cliente.
O MP é uma implantação do Kubernetes. Ele é configurado para um único ambiente da Apigee, apontando para um subdiretório com escopo dentro do sistema de arquivos compartilhado a que o Sincronizador fornece dados.
Um MP consome muitos recursos e precisa estar em um nó de trabalho separado do Cassandra.
Para saber mais, consulte Sobre o plano de ambiente de execução.
- monetização
- Um componente da Apigee que oferece uma maneira flexível e fácil de gerar receita com produtos de API.
- valor mensal usado
- O uso total de um desenvolvedor em um determinado mês, incluindo taxa de configuração + taxa de transação + taxa recorrente.
- pagamentos mensais
- Os pagamentos recorrentes feitos por um desenvolvedor com base nos planos comprados. Os planos de taxas podem ter uma taxa recorrente cobrada a um desenvolvedor a cada mês, independentemente do uso.
N
- namespace
- Clusters virtuais usados para dividir recursos de cluster. Os namespaces são para clusters maiores com muitos usuários. Clusters menores com apenas dezenas de usuários não precisam de namespaces normalmente.
O
- ajuste aberto
- Um ajuste que ainda não foi aplicado a documentos de faturamento publicados.
- mês de faturamento aberto
- Um mês completo ao qual os documentos de faturamento finais não foram publicados.
- Kubernetes de código aberto
- A implementação de referência do Kubernetes. Consulte Kubernetes. O ambiente de execução híbrido da Apigee é executado em Kubernetes de código aberto e em versões de código aberto do Kubernetes que são compatíveis com CNCF.
- organização
Um contêiner para todas as entidades em uma conta da Apigee, incluindo proxies de API, produtos de API, pacotes de API, apps e desenvolvedores. Neste documento, o termo organização da Apigee ou a organização híbrida é usada internamente.
Para instalar e usar a Apigee ou a Apigee híbrida, você precisa ter uma organização da Apigee vinculada a um projeto do Google Cloud. Isso é feito quando você cria a organização em um processo conhecido como provisionamento.
Uma organização da Apigee não é igual a uma organização do Google Cloud. Se houver possibilidade de ambiguidade, o documento precisará especificar que a organização é uma organização da Apigee.
Para mais informações, consulte Tipos de organização.
P
- pod
- Um pod é o bloco básico do Kubernetes: a menor e mais simples unidade no modelo de objeto do Kubernetes que pode ser criada ou implantada. Um pod representa um processo em execução no cluster.
- saldo pré-pago
- Um valor em dinheiro disponível para um desenvolvedor pré-pago pagar antecipadamente pelos pacotes de API.
- desenvolvedor pré-pago
- Um desenvolvedor que paga antecipadamente pelo uso de um produto de API. Os fundos são deduzidos do saldo de um desenvolvedor pré-pago quando o produto de API é usado. O desenvolvedor precisa manter um saldo pré-pago suficiente para comprar o produto de API. Os desenvolvedores recebem o status pré-pago ou pós-pago pelo provedor de API.
- política
- Uma etapa de processamento executada como uma unidade atômica e reutilizável da lógica em um fluxo de API. As políticas comuns incluem o encaminhamento de solicitações para o endpoint adequado, a transformação de um formato de mensagem, a aplicação do controle de acesso, a chamada de serviços remotos para informações adicionais, o mascaramento de dados confidenciais de usuários externos, a inspeção de conteúdo de mensagens em busca de possíveis ameaças, o armazenamento em cache de respostas comuns para melhorar o desempenho e assim por diante. As políticas podem ser executadas condicionalmente com base no conteúdo ou no contexto de uma mensagem de solicitação ou resposta. Por exemplo, uma política de transformação pode ser executada para personalizar um formato de resposta se a mensagem de solicitação tiver sido enviada de um smartphone.
- desenvolvedor pós-pago
- Um desenvolvedor que é cobrado mensalmente pelo uso de produtos de API. O desenvolvedor paga pelo uso de produtos de API com base nas condições de pagamento definidas pelos planos de tarifa. Os desenvolvedores recebem o status pós-pago ou pré-pago pelo provedor da API.
- proxy
- Também proxy de API. Um proxy de API é uma camada de abstração que serve como front para APIs de serviço de back-end e fornece recursos de valor agregado, como segurança, limitação de taxa, cotas, análises etc.
- endpoint de proxy
- Um endpoint de proxy define como o proxy de API interage com os aplicativos do cliente. Você configura o endpoint do proxy com um caminho base
que faz parte do URL ao qual o proxy de API responde.
O URL tem o formato
https://hostname/basepath/pathsuffixes. Consulte Criar um proxy de API.
R
- plano de taxas
- Uma especificação das taxas, outras cobranças e participação na receita para o uso de produtos de API oferecidos em um pacote de API monetizado.
- controlador de replicação
- Reprograma os pods e processa a autocorreção para pods.
- recurso, caminho do recurso
- Um conceito RESTful, um caminho de recurso é um identificador de recurso uniforme (URI) que identifica o caminho de rede para um determinado recurso.
- revisão
- Um pacote numerado de configuração e políticas agrupadas em um proxy de API. Esse termo se distingue de versão, que é a interface da API voltada para o desenvolvedor. Veja a "versão" abaixo.
- plano de ambiente de execução
Os serviços Apigee híbrida gerenciados por você no seu próprio cluster do Kubernetes existem no plano de ambiente de execução. Esses serviços se comunicam por meio de contas de serviço com o plano de gerenciamento.
Inclui MART, Synchronizer, Processadores de mensagens, Cassandra e outros componentes.
Para saber mais, consulte Sobre o plano de ambiente de execução.
- instância de ambiente de execução
- A Apigee pode ser configurada com várias instâncias de ambiente de execução, uma por região geográfica. Um ou mais ambientes podem ser anexados a uma instância de ambiente de execução, oferecendo alta disponibilidade para proxies de API entre regiões.
- serviço
Um termo geral para os aplicativos em contêiner em execução no cluster do Kubernetes no plano de execução. Esses serviços incluem MART, Sincronizador, Processadores de mensagens e Cassandra.
Para saber mais, consulte Sobre o plano de ambiente de execução.
- nó com estado
- Um nó de cluster que requer armazenamento permanente para manter o estado. Consulte Configurar pools de nós dedicados.
- Nó sem estado
- Um nó de cluster que não requer armazenamento permanente. Consulte Configurar pools de nós dedicados.
- Sincronizador
Um serviço de plano de ambiente de execução que pesquisa o plano de gerenciamento em busca da configuração de implantação e eventos para cada ambiente. Ele faz o download dos metadados necessários sobre os proxies implantados, os arquivos de configuração de proxy e muito mais para o ambiente de execução.
O Sincronizador armazena as informações em um sistema de arquivos compartilhado que é lido pelo Processador de mensagens. Ele será executado como um aplicativo DaemonSet. Ele não tem tráfego da API de ambiente de execução e pode sincronizar dados de vários ambientes a partir de um único processo/pod do Kubernetes.
Para saber mais, consulte Sobre o plano de ambiente de execução.
- endpoint de destino
Um endpoint de destino define como o proxy de API interage com os serviços de back-end. Você configura o endpoint de destino para encaminhar solicitações para o serviço de back-end apropriado, incluindo a definição de todas as configurações de segurança, o protocolo HTTP ou HTTPS e outras informações de conexão. Consulte Como alterar o endpoint de destino.
- carregar
- A ação realizada por um desenvolvedor pré-pago para adicionar fundos ao saldo pré-pago.
- transaction_success_def" id="transaction_success_def">transaction success
- uma variável de monetização, se usada, indica que uma transação de API está monetizada ou não. Essa variável pode ser usada para substituir o comportamento padrão, que é baseado no código de status HTTP. Consulte Variáveis de monetização.
- UAP
Plataforma unificada de análise. Um serviço da Apigee no plano de gerenciamento que processa análises de entrada, depuração e dados de status de implantação e os disponibiliza pela IU híbrida da Apigee ou das APIs Apigee.
Para mais informações, consulte Coleta de dados de status de depuração, análise e implantação.
- UDCA
Agente de coleta de dados universal. Um serviço em execução no pod de coleta de dados no plano de ambiente de execução que extrai dados de análises, depuração e status de implantação e os envia ao UAP.
Para mais informações, consulte Coleta de dados de status de depuração, análise e implantação.
- versão
- A versão da interface da API voltada para o desenvolvedor. Por exemplo,
pivotaltracker.com/services/v3, or api.enterprise.apigee.com/v1. Esse termo se distingue derevision, que é o pacote numerado de configuração e políticas agrupado em um proxy de API controlado por versão. Em resumo, as interfaces de API têm versões, enquanto os proxies de API têm revisões. - volume
- Armazenamento compartilhado que pode ser usado por todos os aplicativos em contêiner dentro de um pod.