Tutorial: Como monetizar um produto de API

Antes de iniciar

Sobre este Tutorial

IBM® API Connect inclui um recurso de faturamento por assinatura que permite que os provedores de API definam planos de preços em seus produtos de API e monetizem suas ofertas de API. Se um Produto contiver um Plano de preços, os consumidores da API deverão inserir suas informações de pagamento no Portal do desenvolvedor antes de poderem assinar esse Plano. API Connect suporta a integração com o Stripe Subscription Billing, um serviço de nuvem independente que gerencia planos de produtos monetizados, clientes, suas informações de pagamento e seu histórico de assinaturas, a fim de gerar faturas mensais e cobrar os clientes automaticamente. Com essa integração, o Stripe funciona como sistema de faturamento de assinaturas e como sistema de processamento de pagamentos.

Configure seu recurso de faturamento

Crie um recurso de integração de faturamento do Stripe para sua organização de provedores, concluindo as etapas a seguir.

1. Faça login no API Manager.
2. Na página inicial, clique na caixa Gerenciar recursos.
   
3. Na página Recursos, execute as seguintes tarefas.
   1. No painel esquerdo, selecione Billing (Faturamento ).
   2. No painel direito, clique em Add (Adicionar ).
      

      A página Adicionar integração de faturamento para a integração do Stripe é exibida.

4. Na página Adicionar integração de faturamento, execute as seguintes tarefas.
   1. No campo Título, digite o título de sua integração de faturamento. Por exemplo, My Stripe Billing.
      Observação: O campo Nome é preenchido automaticamente com base no Título que você inseriu.
   2. No campo Publishable key (Chave publicável ), digite a chave de teste de sua conta Stripe.
   3. No campo Secret key (Chave secreta ), digite a chave de teste de sua conta Stripe.
      Dica: se não tiver uma conta Stripe, você pode criar uma aqui: https://dashboard.stripe.com/register. Consulte o painel de controle do Stripe para obter suas chaves de API de teste. Para obter mais informações, consulte https://dashboard.stripe.com/apikeys.
      Observação: cada conta do Stripe vem com dois conjuntos de chaves de API, um para teste e outro para produção. Cada conjunto de chaves de API tem um espaço de nome distinto para objetos Stripe. As chaves de API de teste não podem ver objetos criados por chaves de API de produção e vice-versa. Não é possível trocar as chaves de API de uma de suas integrações de faturamento com as chaves de outra conta, nem trocar as chaves de teste e de produção, pois isso impediria que o site API Connect resolvesse os objetos Stripe que foram criados usando as chaves antigas. Para este tutorial, você deve usar suas chaves de API de teste do Stripe.
   
5. Clique em Add (Adicionar ) para criar seu recurso de integração de faturamento Stripe. A integração My Stripe Billing agora é exibida como o recurso de faturamento.
   

Configurar um catálogo de teste de faixa

Para poder publicar planos de produtos monetizados, você deve adicionar seu recurso de integração de faturamento a um catálogo. Durante esta atividade, você criará um novo catálogo chamado stripe-test, portanto, poderá excluir o catálogo no final do tutorial, se desejar.

1. No API Manager, clique no ícone Manage na barra de navegação lateral.
2. Clique em Adicionar > Criar catálogo e crie um novo catálogo chamado stripe-test.
3. Clique no bloco do catálogo de teste de faixa e, em seguida, clique na guia Configurações do catálogo. Selecione Gateway services e certifique-se de que o catálogo esteja configurado para usar um DataPower® Gateway (v5 compatible) ou um DataPower API Gateway, ou ambos. Em seguida, selecione Portal e crie um Portal do desenvolvedor. Se você não tiver certeza de como definir essas configurações, consulte Criação e configuração de catálogos.
4. Para adicionar o recurso de integração de faturamento ao catálogo, selecione Faturamento e clique em Editar.
   
5. Selecione o recurso My Stripe Billing que você criou anteriormente e clique em Save (Salvar ).
   
   O My Stripe Billing agora está listado como o recurso de integração de faturamento para o catálogo de testes do Stripe.
   

Habilite o método de pagamento Stripe no Portal do desenvolvedor

Para permitir que os consumidores da API se inscrevam em produtos com planos pagos, você deve configurar o método de pagamento Stripe no Portal do desenvolvedor para o catálogo stripe-test.

1. Faça login no Portal do desenvolvedor como administrador.
2. Se o painel do administrador não estiver sendo exibido, clique em Gerenciar para exibi-lo.
3. No painel do administrador, clique em Extend. A guia List (Lista ) da página Extend é aberta e a lista de módulos instalados é exibida.
4. Digite Stripe no filtro de pesquisa, selecione APIC Monetization Stripe Integration e clique em Enable (Ativar ).
   
   As configurações padrão do módulo APIC Monetization Stripe Integration agora estão ativadas, e agora você precisa editar essas configurações.
5. Clique em Configuração > Sistema > IBM API Connect Billing.
6. Altere a opção suspensa de mapeamento do módulo do provedor de faturamento para que seja a recém-ativada integração do APIC Monetization Stripe (ibm_stripe_payment_method) e clique em Salvar configuração.
   
7. Clique em Configuração > Sistema > IBM APIC Stripe Integration e insira as mesmas credenciais da API de teste do Stripe que você inseriu para o recurso de integração My Stripe Billing na Etapa 4 de Configurar seu recurso de faturamento. Em seguida, clique em Salvar configuração.
   
   O método de pagamento Stripe agora está configurado no Portal do desenvolvedor.

Criar e publicar um produto monetizado

Crie um produto que inclua um plano de preços e publique o produto no Portal do desenvolvedor.

1. Primeiro, você precisa fazer o download de uma API de teste para usar com seu produto:
   • Se o seu catálogo de teste de faixa usar um DataPower Gateway (v5 compatible), faça o download do arquivo findbranch.txt para seu sistema de arquivos local. Renomeie esse arquivo para findbranch.yaml.
   • Se o seu catálogo de teste de faixa usar um DataPower API Gateway, faça o download do arquivo findbranch_v6.txt para seu sistema de arquivos local. Renomeie esse arquivo para findbranch.yaml.
   Ou, se preferir, você pode usar uma de suas próprias APIs.
2. Para importar a API para o API Manager, clique no ícone Develop na barra de navegação lateral e, em seguida, clique em Add > API (de REST, GraphQL ou SOAP).
   
3. Certifique-se de que OpenAPI 2.0 esteja selecionado e, em seguida, selecione Existing OpenAPI na seção Import e clique em Next.
   
4. Clique em Arrastar e soltar arquivos aqui ou clique para fazer upload e selecione o arquivo findbranch.yaml em seu sistema de arquivos local para fazer o upload. Em seguida, clique em Next.
   
5. Deixe a opção Activate API desmarcada, pois você ativará a API quando publicar o produto monetizado mais adiante nesta seção. Clique em Avançar para continuar.
6. A página Resumo é exibida, mostrando que a definição de API foi gerada.
   
7. Clique em Edit API (Editar API ) para ver a definição de API gerada e, em seguida, clique no ícone Develop (Desenvolver ) na barra de navegação lateral para continuar a criar um produto monetizado. A FindBranch Deve ser mostrada em sua lista de APIs. Se não for, basta clicar no ícone Refresh para atualizar o navegador.
8. Clique em Adicionar > Produto
   
9. Selecione New product (Novo produto ) e clique em Next (Avançar ).
10. Digite FindBranches no campo Title (Título ) e clique em Next (Avançar ).
    
11. Selecione a API FindBranch que você importou ou sua própria API e clique em Next.
12. Aceite os padrões para os planos e clique em Next. Você adicionará um plano de preços mais tarde.
    
13. Aceite também os padrões para Publish, Visibility e Subscribability e clique em Next.
    
14. A página Summary (Resumo ) é exibida, confirmando que o novo produto foi criado.
    
15. Clique em Edit product (Editar produto ) para continuar com a configuração.
16. Com a guia Design selecionada, clique em Plans (Planos ) no menu de navegação.
    
17. Na seção Integração de faturamento, selecione my-stripe-billing como o recurso de integração de faturamento.
18. Na seção Plans (Planos ), clique em Add (Adicionar ) para criar um novo plano com preços.
19. Digite um título para o novo plano, por exemplo, Gold, mas deixe a caixa de seleção Approval (Aprovação ) desmarcada.
20. Altere a alternância para Ativado para Preço do plano, e a seção Definição de preço do plano será exibida.
21. Selecione Include free trial days (Incluir dias de avaliação gratuita ) e deixe o padrão de 1 para o número de dias de avaliação que um assinante pode usar o Plano sem cobrança, após o qual seu ciclo de cobrança começa.
22. Novamente, deixe os padrões de USD - US Dollar para Moeda e 10 para o Preço por mês a ser cobrado do assinante.
    
23. Na seção Plan rate limits (Limites de tarifa do plano ), altere as Calls (Chamadas ) para 1000 por hora, para diferenciar esse plano do Default Plan (Plano padrão). Clique em Save (Salvar ) para salvar o novo plano de preços.
    
24. Agora você pode publicar o produto monetizado no catálogo de teste de faixa clicando no ícone Options do produto e clicando em Publish (Publicar ).
    
25. Certifique-se de que o catálogo de teste de faixa esteja selecionado e clique em Publish (Publicar ).
26. Você pode verificar se o FindBranches Produto agora está publicado clicando no ícone Manage na barra de navegação lateral e selecionando o bloco stripe-test. O FindBranches O produto agora está listado na guia Products (Produtos ).
    
    Dica: Lembre-se de clicar no ícone Refresh se o produto não for exibido.

Verifique a publicação em sua conta Stripe

Você pode verificar se os planos de produto foram publicados em sua conta do Stripe concluindo as etapas a seguir.

1. Faça login na sua conta de teste do Stripe.
2. Selecione Eventos na navegação do Desenvolvedor.
3. Verifique se os eventos foram criados quando você publicou os planos do produto.

Visualizar o produto monetizado no Portal do desenvolvedor

Você pode verificar se o produto monetizado agora está visível no Portal do desenvolvedor ao concluir as etapas a seguir.

1. Abra o Portal do desenvolvedor para o catálogo stripe-test em seu navegador da Web. Não é necessário fazer login.
2. Você deverá ver o FindBranches Produto na página inicial.
   
3. Clique no FindBranches e os Planos serão exibidos, mostrando os Planos Padrão e Ouro. Você pode ver as informações de preços do Plano Ouro e, se passar o mouse sobre o texto 2 limites de taxa, poderá ver os detalhes do limite de taxa. Um consumidor de API agora pode assinar esse plano monetizado.
   

O Quê foi Feito Neste Tutorial

Neste tutorial, você criou e publicou com êxito um produto monetizado pronto para assinaturas do consumidor da API. Você concluiu as seguintes atividades:

• Criado um recurso de integração de faturamento Stripe.
• Configurou um catálogo de teste de faixa.
• Ativou o Stripe no Portal do desenvolvedor.
• Criou e publicou um produto monetizado.
• Verificou a publicação em sua conta do Stripe.
• Visualizou o produto monetizado no Portal do desenvolvedor.