Glossário

Você está vendo a documentação da Apigee X.
Confira a documentação da Apigee Edge.

Há vários conceitos que são ideias comuns com um significado específico na Apigee.

Termo Definição
APIs Apigee Os endpoints que podem ser usados para configurar ambientes, organizações, proxies de API e outros serviços híbridos.
API proxy 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.
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 app", que usa as APIs criadas por um provedor de API.
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.
Pacote de API Uma coleção de produtos de API que são apresentados aos desenvolvedores como um pacote e normalmente associados a um plano de taxas.
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).
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.
detalhes do saldo Saldo na conta do desenvolvedor com plano pré-pago.
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 central de gerenciamento (ou "plano") Consulte plano de gerenciamento.
ajuste fechado Um ajuste que foi aplicado a documentos de faturamento publicados.
mês de faturamento fechado Um mês completo ao qual os documentos de faturamento foram publicados.
modelo de configuração Consulte modelo.
imagem de contêiner [conteinerizada] Consulte imagem.
plano de controle Consulte plano de gerenciamento.
limite personalizado Um limite, como um limite para o número de transações em um produto de API, que você pode configurar explicitamente usando a monetização. Também chamado de limite explícito.
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.
agente divulgado Na legislação comercial, uma pessoa autorizada a agir em nome de outra pessoa (chamada de principal) para criar uma relação jurídica com um terceiro. Na monetização, um modelo fiscal pode ser configurado para um plano de receita compartilhada de modo que o provedor da API atue como agente divulgado do desenvolvedor para coletar receita (e possivelmente impostos sobre vendas) em nome do desenvolvedor.
modelo fiscal divulgado Um modelo fiscal em que o provedor de API atua como um agente divulgado do desenvolvedor.
ambiente Um contexto de ambiente de execução para APIs. Uma API precisa ser implantada em um ambiente antes de ser acessada no ambiente de execução.
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. Com o GKE, é possível começar a usar o Kubernetes em pouco tempo, eliminando por completo a necessidade de instalar, gerenciar e operar seus próprios clusters do Kubernetes.
modelo fiscal híbrido Um modelo fiscal em que o provedor de API atua como um agente divulgado do desenvolvedor. No entanto, o provedor da API paga o imposto sobre vendas coletado dos assinantes às autoridades fiscais locais em nome do desenvolvedor.
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.
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.
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 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.

Geração de receita 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.
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.
extrato de compensação Um documento financeiro que mostra os saldos líquidos entre as faturas e os extratos de participação na receita.
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 GCP. Se houver possibilidade de ambiguidade, este documento deverá especificar que a "organização" é uma organização da Apigee.

Para mais informações, consulte Tipos de organização.

catálogo de pacotes Uma lista de pacotes de API. Cada pacote está listado com os produtos e os planos de taxas da API.
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.
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.
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 (por meio de uma fatura) pelo uso de produtos de API. O desenvolvedor paga pelo uso dos produtos de API com base nas condições de pagamento definidas pelos planos incluídos na fatura. Os desenvolvedores recebem o status pós-pago ou pré-pago pelo provedor de API.
faixas de preços Um intervalo de preços possíveis que podem ser comercializados.
plano de taxas da tabela de preços Um plano de taxas no qual o desenvolvedor é cobrado uma taxa fixa ou variável por cada transação que envolve um produto de API monetizado.
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 recursos é um recurso uniforme identificado (URI) que identifica o caminho da rede para um determinado recurso.

plano de taxas com participação na receita Um plano de taxas em que uma porcentagem da receita gerada por cada transação envolvendo um produto de API monetizado é compartilhada com o desenvolvedor do app que emite a solicitação.
participação na receita e plano da tabela de preços Um plano de taxas em que uma porcentagem da receita gerada por cada transação envolvendo um produto de API monetizado é compartilhada com o desenvolvedor do app que emite a solicitação. O desenvolvedor também paga uma taxa fixa ou variável por cada transação.
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.

fatura de autofaturamento Um documento financeiro gerado no lugar de um extrato de participação na receita. Ele detalha o valor devido ao desenvolvedor e funciona como uma fatura para o provedor de API em nome do desenvolvedor.
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.

Snuffleupagus Um mamutes grandioso e que se move lentamente, popularizado por um programa de televisão infantil.
plano de taxas padrão Um plano de taxas disponível para compra por todos os desenvolvedores.
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.

tax O total de tributos aplicado ao uso e às taxas do desenvolvedor.
carregar A ação realizada por um desenvolvedor pré-pago para adicionar fundos ao saldo pré-pago.
política de gravação de transações Um mecanismo que permite à monetização capturar parâmetros de transação e atributos personalizados. A monetização precisa dessas informações para realizar o processamento de monetização, como a aplicação de planos de taxas a solicitações e respostas de API com base nos atributos personalizados capturados em cada transaçã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.

agente não divulgado Uma organização (ou operador) que faz parte do fornecimento subjacente de aplicativos, de modo que seja considerada a compra do conteúdo em nome do desenvolvedor (somente para fins fiscais). Como agente não divulgado, a organização (ou operador) pode coletar e contabilizar os impostos devido dos usuários finais. Esse status é relevante apenas para fins fiscais. O status legal do desenvolvedor na cadeia de suprimentos não é afetado.
modelo fiscal não divulgado Um modelo fiscal em que o provedor de API deduz o imposto coletado dos usuários finais e o paga às autoridades fiscais locais.
versão A versão da interface da API voltada para o desenvolvedor. Exemplo: pivotaltracker.com/services/v3, or api.enterprise.apigee.com/v1 Esse termo se distingue de revisão, 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.