Skip to content

Latest commit

 

History

History
208 lines (106 loc) · 8.5 KB

README.md

File metadata and controls

208 lines (106 loc) · 8.5 KB

Lab 04 - Gerenciamento de APIs

Conectando a API Customers ao Red Hat 3Scale

Para isso precisamos seguir 3 passos:

  1. Acesse o 3scale Admin Portal e crie o seu primeiro serviço
  2. Customize o Developer Portal
  3. Integre a sua API com o 3Scale usando o API Gateway

Step 0: Pré reqs

Antes de provisionar o API gateway on-premise, você deverá verificar o seguinte na sua conta 3Scale.

  1. 3scale Domain

    • Você precisa saber qual é o domínio da sua conta 3Scale SaaS.

    • O 3Scale domain é referenciado na URL do seu portal administrativo do 3Scale SaaS, ex: ie: https://<YOURDOMAIN>-admin.3scale.net/p/admin/dashboard.

Passo 1: Defina sua API

  1. Login no portal de administração http://<YOURDOMAIN>-admin.3scale.net

    01-login.png

  2. Caso seja a primeira vez que você acessa o portal 3scale, clique em activate da sua caixa de email, agora feche o wizard clicando no X na parte superior na direita da sua tela

    01a-wizard.png

  3. A primeira página que você verá é a página de API. Daqui podemos criar a nossa API. Clique no link Integration

    02-api-integration.png

  4. Clique em edit integration settings para editar as configurações da API para o gateway

    03-edit-settings.png

  5. Selecione a opção APIcast como opção para deploy do Gateway.

    04-apicast.png

  6. Mantenha API Key (user_key) Authentication

    05-authentication.png

  7. Clique em Update Service

  8. Clique no botão add the Base URL of your API and save the configuration

  9. Expanda a seção mapping rules que define os métodos (HTTP) que serão expostos por essa API

    Nota: O mapeamento padrão é root ("/") of our API resources, something that we might want to avoid.

    07b-mapping-rules.png

  10. Clique em Metric or Method (Define)

    07b-mapping-rules-define.png

  11. Clique em New Method na seção Methods

    07b-new-method.png

  12. Preencha as informações

    Friendly name: Get Customers

    System name: customers_all

    Description: Method to return all customers

    07b-new-method-data.png

  13. Clique em Create Method

  14. Optional: Adicione o método Get Customer caso você tenha feito as intruções para implementar a busca do customer por {id}. Então nomeie para customer_get

  15. Clique em Add mapping rule

    07b-add-mapping-rule.png

  16. Clique para editar este mapping rule

    07b-edit-mapping-rule.png

  17. Insira /customers para o Pattern

  18. Selecione customers_all como Method

    07b-getall-rule.png

  19. Optional:: Clique no botão Add Mapping Rule para adicionar o customer_get como method mapping.

  20. Preencha as informações para acessar sua API:

    Private Base URL: http://camel-ose-springboot-xml-workshop-user-16.apps.ocp.rhbrlab.com:80

    07-baseurl-configuration.png

    Note: Nós estamos utilizando um serviço de API interno porque estamos utilizando tudo dentro do mesmo cluster Openshift

  21. Mais abaixo clique em API Test GET request

  22. Informe /api/customers

  23. Clique em Update the Staging Environment para salvar as alterações e clique em Back to Integration & Configuration para voltar para página das integrações

    08-update-staging.png

  24. Clique no botão Promote v.1 to Production para promover suas configurações de homologação para produção

    08a-promote-production.png

  25. Pronto! Agora a sua camada de gerenciamento de API só irá permitir que chamadas autenticadas cheguem até o seu backend de APIs (Fuse).

Passo 3: Registre uma nova conta no Developer Portal

The focal point of your developers’ experience is the API developer portal, and the level of effort you put into it will determine the level of decreased support costs and increased developer engagement. 3scale provides a built-in, state-of-the-art CMS portal, making it very easy to create your own branded hub with a custom domain to manage developer interactions and increase API adoption.

You can customize the look and feel of the entire Developer Portal to match your own branding. You have complete control over every element of the portal, so you can make it as easy as possible for developers to learn how to use your API.

The Developer Portal's CMS consists of a few elements:

  • Horizontal menu in the Admin Portal with access to content, redirects, and changes
  • The main area containing details of the sections above
  • CMS mode, accessible through the preview option

09-developer-portal.png

Liquid is a simple programming language used for displaying and processing most of the data from the 3scale system available for API providers. In the 3scale platform, it is used to expose server-side data to your API developers, greatly extending the usefulness of the CMS while maintaining a high level of security.

  1. Click on the Developer Portal tab to access the developer portal settings.

    10-developer-portal.png

  2. Click on the Visit Developer Portal to take a look of how your developer portal looks like.

    11-visit-devportal.png

    You can see there is a default portal with information of your API and how to signup. Unfortunately the API information is incorrect.

    12-devportal-overview.png

    Note: We will edit our portal to update it with the correct information and to add the shadowman cool logo.

  3. Go back to your admin portal browser tab and search the content sub-sections for the Layouts and select the </> Main layout

    12-main-layout.png

  4. First look for the navbar section of the main HTML. Replace the {{ provider.name }} for the shadowman image link:

    <img src="https://www.redhat.com/profiles/rh/themes/redhatdotcom/img/logo.png" alt="{{ provider.name }}">

    13-custom-logo.png

  5. Click on Publish button at the bottom of the editor to save the changes and made them available in the site.

    14-publish-devportal.png

  6. Go back to browse the top of the content sub-sections and find the Homepage section.

    15-homepage-devportal.png

  7. Change all the code Echo references in the homepage code for Customer.

  8. Update the API call examples to reflect your real Fuse API calls.

    Note: Use your production base url and add your defined methods. Dont worry if you don't have the "real" output, it won't affect the rest of the lab.

  9. Refresh your Developer Portal's browser tab to check the changes. Your Developer Portal should look like this:

    16-updated-devportal.png

  10. Take the place of one of your developers and signup for the Basic plan.

    16a-signup-limited.png

  11. Fill in your information and your email to register as a developer. Click on the Sign up button.

    16b-signup-form.png

    Note: Use an email address you can actually access.

  12. Check your email and click on the activate link.

    16c-activate-account.png

  13. As your portal is not currently public, you will need your portal code to finish the registration. You can get the code in your admin portal navigating to: Settings > Developer Portal > Domains & Access.

    16d-access-portal.png

  14. Type your portal code to finish the account activation.

    16e-ingress-code.png

  15. Now that your developer account is active, sign in the portal.

    16f-dev-signin.png

  16. You will land in the developers homepage, where you will be able to check your developers settings and retrieve your User Key.

    16g-user-key.png

    Note: Copy down this key as it is used to authenticate yourself to the managed API.

Agora teste as chamadas para sua api através do API Management.