Você está vendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. informações
Antes de começar
Antes de começar a usar a monetização com sua organização da Apigee, é necessário realizar as seguintes tarefas de pré-requisito:
- Crie uma conta do Apigee Edge, conforme descrito em Criar uma conta do Apigee Edge.
- Monetização de compras. Inicialmente, o Edge não inclui a API de monetização nem integra a monetização à interface de gerenciamento. Você precisa comprar o recurso de monetização para incorporar a API de monetização e os componentes de IU de monetização ao Edge para sua organização da Apigee.
Depois de comprar a monetização, você precisa realizar as seguintes tarefas:
- Trabalhe com a equipe de configuração da Apigee para concluir a configuração inicial da monetização. Consulte Configuração inicial com a Apigee.
- Configure a monetização. Consulte Configurar monetização.
- Gere receita com suas APIs. Confira Gerar receita com suas APIs.
- Gerencie a monetização criando relatórios, gerenciando saldos das contas e assim por diante. Consulte Gerenciar monetização.
Configuração inicial com a Apigee
Trabalhe com a equipe de configuração do Apigee Edge para concluir a configuração inicial da monetização. Com base nas informações enviadas, a equipe de configuração definirá o seguinte:
- se a organização é uma empresa de telecomunicações.
- Que tipo de faturamento você quer oferecer para desenvolvedores que compram seus planos de tarifas: pré-pago, pós-pago ou ambos. Consulte Contas pré-pagas e pós-pagas.
- Defina dados extraídos da monetização detalhados ou resumidos para seu sistema de contabilidade e o formato de dados necessário.
- Endereço de e-mail de resposta personalizado. Para notificações por e-mail de monetização enviadas a empresas e desenvolvedores, o endereço padrão noreply@apigee.com é configurado. É necessário solicitar um nome e endereço de resposta personalizados para sua organização.
A equipe de configuração da Apigee executa um script para sincronizar a monetização com a organização e os desenvolvedores, aplicativos e produtos de API que você criou usando o Apigee Edge. O suporte da Apigee pode solicitar que você sincronize sua organização no futuro, conforme descrito em Sincronizar dados do Apigee Edge com a monetização para mais detalhes. Não sincronize os dados de monetização, a menos que instruído pela Apigee.
Configurar monetização
A tabela a seguir resume as etapas necessárias para configurar a monetização na sua organização da Apigee.| Step | Descrição |
|---|---|
| Editar o perfil da sua organização | Como parte da configuração inicial da monetização, a equipe de configuração do Apigee Edge define o perfil da sua organização.
Você precisa editar o perfil da organização para adicionar ou atualizar informações sobre ela, conforme necessário. Por exemplo, talvez seja necessário atualizar o tipo de faturamento, as configurações de moeda ou o modelo fiscal. |
| Gerenciar moedas compatíveis | Como parte da configuração inicial da monetização, a equipe de configuração do Apigee Edge especifica as moedas aceitas pela sua organização e define a moeda padrão.
É possível recuperar as moedas aceitas pela sua organização e adicionar ou excluir moedas compatíveis (para refletir as moedas usadas por um desenvolvedor ou plano de tarifas). Observação: a monetização executa automaticamente um job diário que consegue a taxa de câmbio em dólares americanos para cada moeda aceita. Por padrão, ele é executado todos os dias à meia-noite após um segundo. Para mais detalhes, consulte Programar tarefas de monetização. |
| Especificar Termos e Condições | Opcionalmente, é possível adicionar Termos e Condições ao perfil da organização antes de publicar os planos de tarifa. Depois disso, a versão atual dos Termos e Condições será exibida no portal do desenvolvedor. Observação: os Termos e Condições estão fora do perfil da organização. No perfil da organização, você especifica o local (URL público) dos Termos e Condições. É possível adicionar várias versões dos Termos e Condições para refletir as mudanças ao longo do tempo. |
| Aplicar limites de monetização | Anexar a política MonetizationLimitsCheck aos proxies de API para impor limites de monetização. Especificamente, a política é acionada nas seguintes condições:
|
| Configurar notificações | Configure notificações para avisar os desenvolvedores ou provedores de API sobre um evento específico, como um plano de tarifas recém-publicado. |
Gere receita com suas APIs
Ao gerar receita com APIs, você agrupa um ou mais produtos de API em um pacote e define o plano de tarifas associado.
Um pacote de produtos da API não fica visível para os desenvolvedores até que você publique um plano de tarifas (com uma data de início na data atual ou no futuro). Os desenvolvedores podem registrar seus aplicativos para usar um pacote de produtos da API somente comprando um dos planos de tarifas em vigor. Se um pacote de produtos da API não tiver um plano de tarifa publicado que esteja em vigor no momento, o pacote não será monetizado.
A tabela a seguir resume as etapas necessárias para gerar receita com suas APIs.
| Step | Descrição |
|---|---|
| Gerenciar pacotes de produtos da API | Crie pacotes de produtos de API para agrupar seus produtos de API. Observação: na interface clássica do Edge e na API de monetização, os pacotes de produtos são chamados de pacotes de API. Se quiser usar a API para gerenciar pacotes de produtos, consulte:
|
| Configurar a política de registro de transações | Configure a política de registro de transações para cada um dos produtos de API. A política de registro de transações define o que você quer registrar nos registros de transação de um produto da API, incluindo atributos personalizados. Para usar a API para configurar a política de registro de transações, consulte: |
| Gerenciar e publicar planos de tarifas | Crie um plano de tarifas para definir a abordagem de monetização das APIs. Por exemplo, se você cobra uma taxa fixa ou variável pelo uso da API. Para gerenciar planos de tarifas usando a API, consulte: |
| Comprar um plano de preços publicado | Compre um plano de preços publicado e expire ou cancele um plano comprado, se quiser, usando a API. |
| Configurar a monetização no portal do desenvolvedor | Configure a monetização no seu portal do desenvolvedor para oferecer aos desenvolvedores acesso de autoatendimento à assinatura de planos de preços, ao processamento e ao faturamento de pagamentos automáticos, relatórios, catálogos de produtos e outras configurações específicas de monetização. |
Gerenciar monetização
Depois de configurar a monetização e gerar receita com sua API, é possível realizar uma ou mais etapas resumidas na tabela a seguir:
| Step | Descrição |
|---|---|
| Gerenciar empresas e desenvolvedores | Gerenciou as empresas e os desenvolvedores que usam suas APIs. Um desenvolvedor é uma entidade única, identificada exclusivamente pelo endereço de e-mail. Uma empresa é um conjunto de desenvolvedores gerenciados como uma única entidade. |
| Criar relatórios | Crie relatórios pré-pagos de saldo, receita e variação. Para desenvolvedores pré-pagos, é possível reconciliar relatórios de saldo pré-pago com depósitos bancários. |
| Fazer ajustes de serviço | Faça ajustes de serviço para corrigir discrepâncias nos seus registros, por exemplo. |
| Emitir créditos | Emita créditos de desenvolvedor, se necessário. Para um desenvolvedor pré-pago, um crédito aparece como uma redução no uso que aumenta o saldo pré-pago dele. Para um desenvolvedor pós-pago, um crédito aparece como uma linha separada em uma fatura, reduzindo a cobrança em uma fatura. |
| Gerenciar saldos de contas pré-pagas | Confira o saldo atual da conta pré-paga e recarregue contas pré-pagas ou configure a recarga automática com um provedor de pagamento terceirizado. |
| Gerenciar saldos pós-pagos usando limites de crédito | Ao adicionar uma moeda compatível com a organização, é possível definir um limite de crédito para um desenvolvedor pós-pago. O limite de crédito se aplica a todos os desenvolvedores pós-pagos da organização. Além disso, é possível definir o limite de crédito para um desenvolvedor pós-pago individual. Nesse caso, o limite de crédito substitui qualquer limite definido para a moeda somente para o desenvolvedor especificado. |
| Postar reembolsos | Postar reembolsos para desenvolvedores para transações de compra. |
| Programar jobs de monetização | A monetização fornece um programador de jobs e um conjunto de jobs pré-agendados para serem executados nos horários designados. Gerencie a programação de jobs de monetização usando a API. |
| Conferir o status das transações | Use a API para conferir o status das transações que ocorreram durante um período específico. |
| Sincronizar dados do Apigee Edge com a monetização | Se a Apigee receber uma instrução para fazer isso, sincronize os dados novamente com a monetização para garantir que eles estejam sincronizados. É possível sincronizar o seguinte: organização, produtos de API, desenvolvedores e aplicativos. |
| Excluir dados de monetização da sua organização | Você pode excluir os dados de monetização da sua organização para limpar uma organização de teste ou excluir uma organização. |