Você está visualizando a documentação do Apigee Edge.
Acesse a
documentação da
Apigee X. info
Há vários conceitos que são ideias comuns com um significado exclusivo na Apigee.
| Termo | Definição |
|---|---|
| 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. |
| 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 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 API cria APIs (usando o Edge) para serem usadas por consumidores de API (desenvolvedores de apps). |
| 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. |
| 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. |
| 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. Por padrão, as organizações da Apigee são provisionadas com dois ambientes: "test" e "prod". O ambiente "test" é geralmente usado para implantar APIs em teste. O ambiente "prod" normalmente é usado para implantar APIs para uso de produção. |
| 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. |
| limite implícito | Um limite, como um limite de saldo pré-pago do desenvolvedor, definido pela monetização. |
| monetização | Um componente dos serviços para desenvolvedores do Apigee Edge 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. |
| 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. |
| organização | Um contêiner para todos os objetos na sua conta da Apigee, incluindo APIs, produtos de API, pacotes de API, apps e desenvolvedores. É preciso ter uma conta de usuário para cada organização da qual você é membro. A maioria dos usuários terá uma conta em apenas uma organização. É preciso fornecer suas credenciais (nome de usuário e senha) e o nome da organização com cada solicitação de API que você enviar. |
| catálogo de pacotes | Uma lista de pacotes de API. Cada pacote está listado com os produtos e os planos de taxas da API. |
| 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. |
| caminho de recursos |
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. |
| 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. |
| plano de taxas padrão | Um plano de taxas disponível para compra por todos os desenvolvedores. |
| 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. |
| 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. Por exemplo, pivotaltracker.com/services/v3 ou api.enterprise.apigee.com/v1. Esse termo é diferente da "revisão", que é o pacote numerado com controle de versões de configurações e políticas agrupadas em um proxy de API. Em resumo, as interfaces de API têm versões, enquanto os proxies de API têm revisões. |