Você está visualizando a documentação do Apigee Edge.
Acesse a
documentação da
Apigee X. info
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.
- Comprar a monetização. O Edge não inclui inicialmente a API de monetização nem integra a monetização à interface de gerenciamento. É necessário comprar o recurso de monetização para incorporar a API e os componentes da 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 do Apigee para concluir a configuração inicial de monetização. Consulte Configuração inicial com a Apigee.
- Configure a monetização. Consulte Configurar a monetização.
- Gere receita com suas APIs. Consulte Gerar receita com suas APIs.
- Gerencie a monetização criando relatórios, gerenciando saldos de contas e assim por diante. Consulte Gerenciar a 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 suas informações, a equipe de configuração vai definir o seguinte:
- Se a sua organização é uma empresa de telecomunicações.
- Qual tipo de faturamento você quer oferecer aos desenvolvedores que compram seus planos de tarifas: pré-pago, pós-pago ou ambos. Consulte Contas pré-pagas e pós-pagas.
- Se você quer dados detalhados ou resumidos extraídos da monetização no seu sistema de contabilidade e o formato de dados necessário.
- Endereço de resposta de e-mail personalizado. Para notificações por e-mail de monetização enviadas a empresas e desenvolvedores, um endereço padrão noreply@apigee.com é configurado. Você precisa 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 sua organização e todos 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. Não sincronize dados de monetização, a menos que seja instruído pela Apigee.
Configurar a monetização
A tabela a seguir resume as etapas necessárias para configurar a monetização da sua organização da Apigee.| Etapa | 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 configura o perfil da sua organização.
Você precisa editar o perfil da organização para adicionar ou atualizar informações sobre ela, conforme apropriado. Por exemplo, talvez seja necessário atualizar o tipo de faturamento, as configurações de moeda ou o modelo de imposto. |
| Gerenciar as moedas aceitas | 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 compatíveis com sua organização e adicionar ou excluir moedas compatíveis para refletir as moedas usadas por um desenvolvedor ou plano de preços. Observação: a monetização executa automaticamente um job diário que extrai a taxa de câmbio em dólares americanos para cada moeda aceita. Por padrão, o job é executado todos os dias um segundo depois da meia-noite. Para mais detalhes, consulte Programar jobs de monetização. |
| Especificar os termos e condições | Você pode adicionar os Termos e Condições ao perfil da sua organização antes de publicar os planos de preços. Depois que um plano de preços é publicado, a versão atual dos Termos e Condições é exibida no portal para desenvolvedores. Observação: os Termos e Condições estão fora do perfil da sua organização. No perfil da sua 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 | Anexe a política MonetizationLimitsCheck aos proxies de API para aplicar os limites de monetização. Especificamente, a política é acionada nas seguintes condições:
|
| Configurar notificações | Configure notificações para informar desenvolvedores ou provedores de API sobre um evento específico, como um plano de taxas recém-publicado. |
Gerar receita com suas APIs
Ao monetizar APIs, você agrupa um ou mais produtos de API em um pacote de produtos de API e define o plano de tarifas associado.
Um pacote de produtos de API não fica visível para os desenvolvedores até que você publique um plano de preços para o pacote (com uma data de início atual ou futura). Os desenvolvedores só podem registrar os apps para usar um pacote de produtos de API comprando um dos planos de tarifas em vigor. Se um pacote de produto de API não tiver um plano de taxas publicado em vigor, o pacote não vai gerar receita.
A tabela a seguir resume as etapas necessárias para gerar receita com suas APIs.
| Etapa | Descrição |
|---|---|
| Gerenciar pacotes de produtos de 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. Para usar a API para gerenciar pacotes de produtos de API, consulte: |
| Configurar a política de gravação de transações | Configure a política de registro de transações para cada um dos seus produtos de API. A política de gravação de transações define o que você quer capturar nos registros de transações de um produto de API, incluindo atributos personalizados. Para usar a API para configurar a política de gravação de transações, consulte: |
| Gerenciar e publicar planos de taxas | Crie um plano de tarifas para definir a abordagem de monetização das suas APIs. Por exemplo, se você cobra uma taxa fixa ou variável pelo uso da sua API. Para gerenciar planos de taxas usando a API, consulte: |
| Comprar um plano de taxas publicado | Compre um plano de taxas publicado e, se quiser, expire ou cancele um plano de taxas comprado usando a API. |
| Configurar a monetização no portal do desenvolvedor | Configure a monetização no portal do desenvolvedor para oferecer aos desenvolvedores acesso de autoatendimento para assinaturas do plano de taxas, processamento e 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 da API, você pode realizar uma ou mais das etapas resumidas na tabela a seguir:
| Etapa | Descrição |
|---|---|
| Gerenciar empresas e desenvolvedores | Gerenciou as empresas e os desenvolvedores que usam suas APIs. Um desenvolvedor é uma única entidade, identificada exclusivamente pelo endereço de e-mail. Uma empresa é uma coleção de desenvolvedores gerenciados como uma única entidade. |
| Criar relatórios | Crie relatórios de saldo pré-pago, receita e variação. Para desenvolvedores pré-pagos, é possível conciliar relatórios de saldo pré-pago com depósitos bancários. |
| Fazer ajustes de faturamento | Faça ajustes de faturamento para corrigir discrepâncias nos seus registros, por exemplo. |
| Emitir créditos | Emita créditos para desenvolvedores, se necessário. Para um desenvolvedor pré-pago, o crédito aparece como uma redução no uso que aumenta o saldo pré-pago do desenvolvedor. Para um desenvolvedor pós-pago, um crédito aparece como uma linha separada em uma fatura, reduzindo a cobrança. |
| Gerenciar saldos de contas pré-pagas | Confira o saldo atual da conta pré-paga e faça recargas ou configure recargas automáticas usando um provedor de pagamentos de terceiros. |
| Gerenciar saldos pós-pagos usando limites de crédito | Ao adicionar uma moeda aceita para uma organização, você pode 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 na organização. Além disso, é possível definir o limite de crédito para um desenvolvedor pós-pago específico. Nesse caso, o limite de crédito substitui qualquer limite definido para a moeda apenas do desenvolvedor especificado. |
| Reembolsos pós-venda | Publicar reembolsos para desenvolvedores em transações de compra. |
| Agendar jobs de monetização | A monetização fornece um programador de jobs e um conjunto de jobs que são programados com antecedência para serem executados em horários determinados. Gerencie a programação de jobs de monetização usando a API. |
| Conferir o status das transações | Confira o status das transações que ocorreram durante um período especificado usando a API. |
| Sincronizar dados do Apigee Edge com a monetização | Se a Apigee solicitar, sincronize os dados com a monetização novamente 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 | Talvez você queira excluir dados de monetização da sua organização para limpar uma organização de teste ou excluir uma organização. |