Glossário

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

Os seguintes conceitos são ideias comuns que têm um significado único no Apigee.

A

Caminho base e recursos da API
Uma API é composta por um caminho base e um conjunto de recursos (também conhecidos como caminhos de recursos). Para cada API, define um único URL raiz (também denominado caminho base) e vários caminhos de recursos. Pode pensar numa API simplesmente como um conjunto de URIs, todos os quais partilham um caminho de base comum. Para facilitar a gestão das suas APIs, o Apigee aumenta estes URIs não processados com nomes a apresentar e descrições.
Consumidor da API
Sinónimo de programador de apps, que usa as APIs criadas por um fornecedor de APIs.
Programador de APIs
Um engenheiro de software numa organização fornecedora de APIs que cria APIs. Essas APIs são usadas pelos programadores de apps (consumidores de APIs) para criar apps.
Produto da API
Uma coleção de recursos de API (URIs) combinados com um plano de serviço e apresentados aos programadores como um pacote. O produto da API também pode incluir alguns metadados específicos da sua empresa para monitorização ou estatísticas. É possível rentabilizar um ou mais recursos incluindo-os num produto API, que pode ser agrupado num pacote API para rentabilização.
Fornecedor de APIs
Um fornecedor de APIs cria APIs (através do Apigee) para os consumidores de APIs (programadores de apps) usarem.
API proxy
Um proxy que funciona como uma fachada para a sua API existente. Em vez de chamar a API existente, os programadores começam a chamar a nova API gerada pelo Apigee. Esta fachada desvincula a sua interface pública da API de back-end, protegendo os programadores de alterações de back-end, ao mesmo tempo que lhe permite inovar na periferia sem afetar as suas equipas de desenvolvimento internas. À medida que faz alterações no back-end, os programadores continuam a chamar a mesma API sem interrupções. Em cenários mais avançados, o Apigee permite-lhe expor várias interfaces à mesma API, o que lhe dá liberdade para personalizar a assinatura de uma API de forma a satisfazer as necessidades de vários nichos de programadores em simultâneo.
APIs Apigee
Os pontos finais que pode usar para configurar ambientes, organizações, proxies de API e outros serviços híbridos.
programador de apps
Os programadores de apps registam as respetivas apps junto de um fornecedor de APIs, que é a forma como os programadores de apps obtêm as chaves da API de que precisam para chamar os proxies da API do fornecedor.
apps
Os seus programadores usam apps para aceder aos recursos nos seus produtos de API. Quando cria uma app, seleciona o produto de API a incluir e o Apigee gera uma chave. Cada app tem uma única chave que dá acesso a vários produtos API. As apps permitem-lhe controlar quem pode aceder aos seus recursos. Pode controlar quem tem acesso aos seus produtos de API revogando e atualizando a chave de uma app. Além disso, pode controlar o acesso a pacotes de recursos revogando ou eliminando o acesso aos produtos numa app.

B

detalhes do saldo
Para um programador pré-pago, o saldo na conta do programador.

C

Cassandra

(Apenas para o Apigee hybrid) O repositório de dados de tempo de execução que armazena as configurações das aplicações, os contadores de quotas distribuídos, as chaves de API e os tokens OAuth para as aplicações em execução no gateway.

Este é um StatefulSet que requer muitos recursos e deve estar num nó de trabalho separado do processador de mensagens.

Para mais informações, consulte o artigo Acerca do plano de tempo de execução.

infraestrutura (ou plano) de gestão central
Veja o plano de gestão.
imagem [em contentor]
Veja a imagem.
plano de controlo
Veja o plano de gestão.

D

implementar

No Apigee, implementa um proxy de API num ambiente para o tornar acessível aos clientes de aplicações na Internet, de forma pública ou privada, consoante a configuração de rede.

programador
Um programador refere-se a uma função que um utilizador do Apigee pode desempenhar. Existem dois tipos de programadores no Apigee:
  • Programadores de proxies de API: criam os proxies de API e aplicam políticas.
  • Programadores de aplicações: criam aplicações que consomem proxies de API.
Plano de tarifa da categoria de programador
Um plano tarifário que se aplica a todos os programadores numa categoria específica e está disponível para compra por todos os programadores nessa categoria.
Plano de tarifa de programador
Um plano tarifário que se aplica a um programador específico e está disponível para compra apenas por esse programador.

E

ambiente

Um ambiente do Apigee é um ambiente de software isolado, numa organização, onde implementa proxies de API. O ambiente pode ser dimensionado para satisfazer as exigências dos proxies implementados. Pode criar vários ambientes numa organização.

grupo de ambientes

Um grupo de ambientes é um grupo de ambientes do Apigee com um ou mais nomes de anfitrião. O nome do anfitrião faz parte do URL usado para chamar proxies de API implementados em qualquer ambiente no grupo de ambientes.

limite explícito
Consulte o limite personalizado.

G

GCR
Repositório de contentores Google.
GKE
Google Kubernetes Engine. Um ambiente gerido pela Google e pronto para produção para implementar aplicações em contentores no Kubernetes. O GKE permite-lhe começar a usar o Kubernetes rapidamente, eliminando completamente a necessidade de instalar, gerir e operar os seus próprios clusters do Kubernetes.

I

repositório de imagens
Um grupo de imagens de contentores partilhados.
Limite implícito
Um limite (como um limite de saldo pré-pago de programador) definido pela rentabilização.
Entrada/controlador de entrada
Uma app contentorizada que encaminha o tráfego de fora do cluster para serviços dentro do cluster.

mil

KMS
Key Management Service. Armazena, mantém e apresenta chaves e tokens OAuth para encriptar e desencriptar o tráfego. O KMS do Apigee gere chaves para apps, programadores e produtos de API.
KVM
Mapa de chaves-valores. Uma coleção personalizada de pares de strings de chave/valor que está encriptada ou não encriptada. Para mais informações, consulte Usar mapas de chaves-valores.
Máquina de administração do Kubernetes
A sua máquina local que usa para executar comandos no cluster do Kubernetes. Normalmente, esta máquina é um computador desktop que tem acesso às suas VMs do Kubernetes.

M

plano de gestão
Os serviços centrais alojados na Google que comunicam com o plano de tempo de execução através de contas de serviço.
MART

A API para dados de tempo de execução interage com o repositório de dados de tempo de execução local (Cassandra). Serve como fornecedor de API para a API Apigee pública para aceder e gerir dados de tempo de execução.

O MART é uma aplicação sem estado, tal como os processadores de mensagens. É uma app contentorizada do Kubernetes.

Para mais informações, consulte o artigo Acerca do plano de tempo de execução.

nó principal
Um termo do Kubernetes para um nó que inclui o apiserver, o cloud-controller-manager (CCM), o scheduler e o kube-controller-manager.
Processador de mensagens

(Apenas para o Apigee hybrid) O processador de mensagens avalia um pedido recebido, executa quaisquer políticas do Apigee e chama os sistemas de back-end e outros sistemas para obter dados. Assim que essas respostas forem recebidas, o processador de mensagens formata uma resposta e devolve-a ao cliente.

O MP é uma implementação do Kubernetes. Está configurado para um único ambiente do Apigee, apontando para um subdiretório com âmbito no sistema de ficheiros partilhado ao qual o sincronizador fornece dados.

Um MP requer muitos recursos e deve estar num nó de trabalho separado do Cassandra.

Para mais informações, consulte o artigo Acerca do plano de tempo de execução.

rentabilização
Um componente do Apigee que oferece uma forma fácil de usar e flexível de rentabilizar produtos de API.
montante mensal usado
A utilização total de um programador num determinado mês, que inclui a taxa de configuração + a taxa de transação + a taxa recorrente.
pagamentos mensais
Os pagamentos recorrentes feitos por um programador com base nos planos comprados. Os planos tarifários podem ter uma taxa recorrente que é cobrada a um programador todos os meses, independentemente da utilização.

N

espaço de nome
Clusters virtuais usados para dividir os recursos de cluster. Os espaços de nomes destinam-se a clusters maiores com muitos utilizadores. Normalmente, os clusters mais pequenos com apenas dezenas de utilizadores não precisam de espaços de nomes.

O

abre o ajuste
Um ajuste que ainda não foi aplicado em documentos de faturação publicados.
mês de faturação aberto
Um mês civil completo para o qual não foram publicados documentos de faturação finais.
Kubernetes de código aberto
A implementação de referência do Kubernetes. Consulte Kubernetes. O tempo de execução do Apigee Hybrid é executado no Kubernetes de código aberto e em versões baseadas em código aberto do Kubernetes que estão em conformidade com a CNCF.
organização

Um contentor para todas as entidades numa conta do Apigee, incluindo proxies de API, produtos de API, pacotes de API, apps e programadores. Este documento usa os termos organização do Apigee ou organização com capacidade híbrida de forma intercambiável.

Para instalar e usar o Apigee ou o Apigee Hybrid, tem de ter uma organização do Apigee associada a um projeto do Google Cloud. Isto é feito quando cria a organização num processo conhecido como aprovisionamento.

Uma organização do Apigee não é igual a uma organização do Google Cloud. Quando existir a possibilidade de ambiguidade, este documento deve especificar que a organização é uma organização do Apigee.

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

P

cápsula
Um pod é o bloco de construção básico do Kubernetes: a unidade mais pequena e simples no modelo de objeto do Kubernetes que cria ou implementa. Um pod representa um processo em execução no seu cluster.
saldo pré-pago
Um valor disponível para um programador pré-pago pagar antecipadamente pacotes de APIs.
pré-pago para programadores
Um programador que paga antecipadamente a utilização de um produto de API. Os fundos são deduzidos do saldo de um programador pré-pago quando o produto da API é usado. O programador tem de manter um saldo pré-pago suficiente para comprar o produto API. Os programadores recebem o estado pré-pago ou pós-pago do fornecedor da API.
política
Um passo de processamento que é executado como uma unidade de lógica atómica e reutilizável num fluxo da API. As políticas típicas incluem o encaminhamento de pedidos para o ponto final adequado, a transformação de um formato de mensagem, a aplicação do controlo de acesso, a chamada de serviços remotos para obter informações adicionais, a ocultação de dados confidenciais de utilizadores externos, a análise do conteúdo das mensagens para detetar potenciais ameaças, o armazenamento em cache de respostas comuns para melhorar o desempenho, entre outros. 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 pedido tiver sido enviada a partir de um smartphone.
programador pós-pago
Um programador que recebe faturação mensal pela utilização de produtos de API. O programador paga pela utilização de produtos de API com base nas condições de pagamento definidas pelos planos tarifários. Os programadores recebem o estado pós-pago ou pré-pago do fornecedor de API.
proxy
Também API proxy. Um proxy de API é uma camada de abstração que interage com as APIs de serviço de back-end e oferece funcionalidades de valor acrescentado, como segurança, limitação de taxa, quotas, estatísticas e muito mais.
ponto final do proxy
Um ponto final do proxy define a forma como o proxy da API interage com as aplicações cliente. Configura o ponto final 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 o artigo Crie um proxy de API.

R

Plano de tarifas
Uma especificação das taxas, outros encargos e partilha de receita para a utilização de produtos de API oferecidos num pacote de APIs rentabilizado.
controlador de replicação
Reprograma pods e processa a autorrecuperação de pods.
recurso, caminho do recurso
Um conceito RESTful, um caminho de recurso é um identificador uniforme de recursos (URI) que identifica o caminho de rede para um determinado recurso.
revisão
Um pacote numerado e controlado por versões de configuração e políticas agrupadas num proxy de API. Este termo distingue-se de versão, que é a interface da API para programadores. Consulte "Versão" abaixo.
plano de tempo de execução

Os serviços híbridos do Apigee que gere no seu próprio cluster do Kubernetes existem no plano de tempo de execução. Estes serviços comunicam através de contas de serviço com o plano de gestão.

Inclui o MART, o sincronizador, os processadores de mensagens, o Cassandra e outros componentes.

Para mais informações, consulte o artigo Acerca do plano de tempo de execução.

instância de tempo de execução
O Apigee pode ser configurado com várias instâncias de tempo de execução, uma por região geográfica. Pode anexar um ou mais ambientes a uma instância de tempo de execução, o que oferece alta disponibilidade para proxies de API em várias regiões.

S

serviço

Um termo geral para as apps contentorizadas em execução no seu cluster do Kubernetes no plano de execução. Estes serviços incluem o MART, o sincronizador, os processadores de mensagens e o Cassandra.

Para mais informações, consulte o artigo Acerca do plano de tempo de execução.

nó com estado
Um nó de cluster que requer armazenamento persistente para manter o estado. Consulte o artigo Configure node pools dedicados.
nó sem estado
Um nó de cluster que não requer armazenamento persistente. Consulte Configure node pools dedicados.
Sincronizador

Um serviço de plano de tempo de execução que consulta o plano de gestão para obter a configuração de implementação e os eventos de cada ambiente. Transfere os metadados necessários sobre os proxies implementados, os ficheiros de configuração de proxy e muito mais para o plano de tempo de execução.

O sincronizador armazena as respetivas informações num sistema de ficheiros partilhado que o processador de mensagens lê. Esta é executada como uma aplicação DaemonSet; não tem tráfego de API de tempo de execução e pode sincronizar dados para vários ambientes a partir de um único processo/pod do Kubernetes.

Para mais informações, consulte o artigo Acerca do plano de tempo de execução.

B

ponto final de destino

Um ponto final de destino define a forma como o proxy de API interage com os serviços de back-end. Configura o ponto final de destino para encaminhar pedidos para o serviço de back-end adequado, incluindo a definição de definições de segurança, protocolo HTTP ou HTTPS e outras informações de ligação. Consulte a secção Alterar o ponto final alvo.

recarregar
A ação realizada por um programador pré-pago para adicionar fundos ao saldo pré-pago.
transaction_success_def" id="transaction_success_def">êxito da transação
A variável de rentabilização
, se usada, indica se uma transação de API é rentabilizada ou não. Esta variável pode ser usada para substituir o comportamento predefinido que se baseia no código de estado HTTP. Consulte as variáveis de rentabilização.

U

UAP

Plataforma de análise unificada. Um serviço Apigee no plano de gestão que processa os dados de estatísticas, depuração e estado de implementação recebidos e os disponibiliza através da IU híbrida do Apigee ou das APIs Apigee.

Para mais informações, consulte o artigo Recolha de dados de depuração, estatísticas e estado de implementação.

UDCA

Agente de recolha de dados universal. Um serviço executado no pod de recolha de dados no plano de tempo de execução que extrai dados de estatísticas, depuração e estado de implementação e envia-os para a UAP.

Para mais informações, consulte o artigo Recolha de dados de depuração, estatísticas e estado de implementação.

V

versão
A versão da interface da API orientada para o programador. Por exemplo, pivotaltracker.com/services/v3, or api.enterprise.apigee.com/v1. (Este termo distingue-se de revision, que é o pacote numerado e controlado por versões de configuração e políticas incluídas num proxy de API. Resumidamente, as interfaces de API têm versões, enquanto os proxies de API têm revisões.
volume
Armazenamento partilhado que pode ser usado por todas as aplicações em contentores num pod.