Acerca da Gestão de APIAbout API Management

O gerenciamento de API (APIM) é uma maneira de criar gateways de API modernos e consistentes para serviços de back-end existentes.API Management (APIM) is a way to create consistent and modern API gateways for existing back-end services.

O gerenciamento de API ajuda as organizações a publicar APIs para desenvolvedores externos, parceiros e internos para desbloquear o potencial de seus dados e serviços.API Management helps organizations publish APIs to external, partner, and internal developers to unlock the potential of their data and services. Um pouco por todo o lado, as empresas procuram expandir as suas operações como uma plataforma digital, criando novos canais, encontrando novos clientes e promovendo um envolvimento mais profundo com os clientes existentes.Businesses everywhere are looking to extend their operations as a digital platform, creating new channels, finding new customers and driving deeper engagement with existing ones. A Gestão de API fornece as competências essenciais para garantir um programa de API bem-sucedido através do envolvimento dos programadores, das informações de negócio, da análise, da segurança e da proteção.API Management provides the core competencies to ensure a successful API program through developer engagement, business insights, analytics, security, and protection. Pode utilizar a API Management do Azure para iniciar um programa de API totalmente funcional baseado em qualquer back-end.You can use Azure API Management to take any backend and launch a full-fledged API program based on it.

Este artigo apresenta uma descrição geral dos cenários comuns que envolvem a APIM.This article provides an overview of common scenarios that involve APIM. Também fornece uma breve descrição geral dos componentes principais do sistema de APIM.It also gives a brief overview of the APIM system's main components. O artigo, em seguida, apresenta uma descrição geral mais detalhada de cada componente.The article, then, gives a more detailed overview of each component.

Descrição geralOverview

Para utilizar a API Management, os administradores criam APIs.To use API Management, administrators create APIs. Cada API é constituída por uma ou mais operações e cada API pode ser adicionada a um ou mais produtos.Each API consists of one or more operations, and each API can be added to one or more products. Para utilizar uma API, os programadores subscrevem um produto que contém essa API e, em seguida, podem chamar a operação da API, estando sujeitos a todas as políticas de utilização que possam estar em vigor.To use an API, developers subscribe to a product that contains that API, and then they can call the API's operation, subject to any usage policies that may be in effect. Os cenários comuns incluem:Common scenarios include:

  • Proteção da infraestrutura móvel mediante o controlo de acesso com chaves de API, prevenção de ataques DoS através da utilização de limitação ou utilização de políticas de segurança avançadas como a validação de token JWT.Securing mobile infrastructure by gating access with API keys, preventing DOS attacks by using throttling, or using advanced security policies like JWT token validation.
  • Ativação de ecossistemas de parceiros ISV ao proporcionar uma integração mais rápida dos parceiros através do portal do programador e construir uma fachada de API para a desassociação de implementações internas que não estão prontas para consumo por parte dos parceiros.Enabling ISV partner ecosystems by offering fast partner onboarding through the developer portal and building an API facade to decouple from internal implementations that are not ripe for partner consumption.
  • Execução de um programa de API interno ao oferecer uma localização centralizada para que a organização possa comunicar sobre a disponibilidade e as alterações mais recentes às APIs ou controlar o acesso com base em contas organizacionais, tudo isto baseado num canal seguro entre o gateway da API e o back-end.Running an internal API program by offering a centralized location for the organization to communicate about the availability and latest changes to APIs, gating access based on organizational accounts, all based on a secured channel between the API gateway and the backend.

O sistema é constituído pelos seguintes componentes:The system is made up of the following components:

  • O gateway da API é o ponto final que:The API gateway is the endpoint that:

    • Aceita as chamadas à API e as encaminha para os seus back-ends.Accepts API calls and routes them to your backends.
    • Verifica as chaves de API, os tokens JWT, os certificados e outras credenciais.Verifies API keys, JWT tokens, certificates, and other credentials.
    • Impõe quotas de utilização e limites de velocidade.Enforces usage quotas and rate limits.
    • Transforma imediatamente a sua API sem modificações do código.Transforms your API on the fly without code modifications.
    • Coloca em cache as respostas de back-end, quando estão configuradas.Caches backend responses where set up.
    • Regista metadados de chamadas para fins de análise.Logs call metadata for analytics purposes.
  • O portal do Azure é a interface administrativa onde configura o seu programa de API.The Azure portal is the administrative interface where you set up your API program. Utilize-o para:Use it to:

    • Definir ou importar o esquema de API.Define or import API schema.
    • Integrar APIs em produtos.Package APIs into products.
    • Configurar políticas como quotas ou transformações nas APIs.Set up policies like quotas or transformations on the APIs.
    • Obter conhecimentos aprofundados a partir da análise.Get insights from analytics.
    • Gerir utilizadores.Manage users.
  • O Portal do programador serve como a principal presença na Web para os programadores, onde podem:The Developer portal serves as the main web presence for developers, where they can:

    • Ler a documentação da API.Read API documentation.
    • Experimentar uma API através da consola interativa.Try out an API via the interactive console.
    • Criar uma conta e subscrever para obter chaves de API.Create an account and subscribe to get API keys.
    • Aceder a análises sobre a sua própria utilização.Access analytics on their own usage.

Para obter mais informações, consulte gerenciamento de API baseado em nuvem: O aproveitamento do White Paper sobre o poder do APIs em PDF.For more information, see the Cloud-based API Management: Harnessing the Power of APIs PDF whitepaper. Este documento técnico introdutório sobre a API Management da CITO Research abrange:This introductory whitepaper on API Management by CITO Research covers:

  • Requisitos e desafios de API comunsCommon API requirements and challenges
  • Desassociar APIs e apresentar fachadasDecoupling APIs and presenting facades
  • Ajudar os programadores a começar a trabalhar rapidamenteGetting developers up and running quickly
  • Proteger o acessoSecuring access
  • Análise e métricasAnalytics and metrics
  • Obtenção de controlo e conhecimentos aprofundados com uma plataforma de API ManagementGaining control and insight with an API Management platform
  • Utilização de soluções em nuvem versus no localUsing cloud vs on-premises solutions
  • Gestão de API do AzureAzure API Management

APIs e operações APIs and operations

As APIs são a base de uma instância de serviço de API Management.APIs are the foundation of an API Management service instance. Cada API representa um conjunto de operações disponíveis para os programadores.Each API represents a set of operations available to developers. Cada API contém uma referência ao serviço de back-end que implementa a API e as respetivas operações efetuam o mapeamento para as operações implementadas pelo serviço de back-end.Each API contains a reference to the back-end service that implements the API, and its operations map to the operations implemented by the back-end service. As operações da API Management são altamente configuráveis, com controlo sobre o mapeamento de URL, parâmetros de caminho e consulta, conteúdo do pedido e da resposta e colocação em cache das respostas de operações.Operations in API Management are highly configurable, with control over URL mapping, query and path parameters, request and response content, and operation response caching. Também é possível implementar políticas de limite de taxa, quotas e restrição de IP ao nível da API ou da operação individual.Rate limit, quotas, and IP restriction policies can also be implemented at the API or individual operation level.

Para obter mais informações, consulte Como criar APIs e Como adicionar operações a uma API.For more information, see How to create APIs and How to add operations to an API.

Produtos Products

Os produtos são a forma como as APIs são apresentadas aos programadores.Products are how APIs are surfaced to developers. Os produtos na API Management têm uma ou mais APIs e são configurados com um título, uma descrição e termos de utilização.Products in API Management have one or more APIs, and are configured with a title, description, and terms of use. Os produtos podem ser Abertos ou Protegidos.Products can be Open or Protected. Os produtos protegidos têm de ser subscritos antes de poderem ser utilizados, enquanto os produtos abertos podem ser utilizados sem uma subscrição.Protected products must be subscribed to before they can be used, while open products can be used without a subscription. Quando um produto estiver pronto para ser utilizado pelos programadores, pode ser publicado.When a product is ready for use by developers, it can be published. Assim que for publicado, pode ser visualizado (e subscrito, no caso dos produtos protegidos) pelos programadores.Once it is published, it can be viewed (and in the case of protected products subscribed to) by developers. A aprovação de subscrição é configurada ao nível do produto e pode exigir a aprovação do administrador ou ser aprovada automaticamente.Subscription approval is configured at the product level and can either require administrator approval, or be auto-approved.

Os grupos são utilizados para gerir a visibilidade dos produtos para os programadores.Groups are used to manage the visibility of products to developers. Os produtos concedem visibilidade aos grupos e os programadores podem ver e subscrever os produtos que estão visíveis para os grupos a que pertencem.Products grant visibility to groups, and developers can view and subscribe to the products that are visible to the groups in which they belong.

Grupos Groups

Os grupos são utilizados para gerir a visibilidade dos produtos para os programadores.Groups are used to manage the visibility of products to developers. A Gestão de API tem os seguintes grupos de sistema imutáveis:API Management has the following immutable system groups:

  • Administradores – os administradores da subscrição do Azure são membros deste grupo.Administrators - Azure subscription administrators are members of this group. Os administradores gerem as instâncias de serviço de API Management, criando as APIs, as operações e os produtos que são utilizados pelos programadores.Administrators manage API Management service instances, creating the APIs, operations, and products that are used by developers.
  • Programadores – os utilizadores autenticados do portal do programador enquadram-se neste grupo.Developers - Authenticated developer portal users fall into this group. Os programadores são os clientes que criam aplicações utilizando as suas APIs.Developers are the customers that build applications using your APIs. Os programadores têm acesso ao portal do programador e criam aplicações que chamam as operações de uma APIDevelopers are granted access to the developer portal and build applications that call the operations of an API.
  • Convidados – os utilizadores não autenticados do portal do programador, tais como potenciais clientes que visitam o portal do programador de uma instância de API Management, enquadram-se neste grupo.Guests - Unauthenticated developer portal users, such as prospective customers visiting the developer portal of an API Management instance fall into this group. Estes podem ter determinados acessos só de leitura, como a capacidade de ver APIs mas não de as chamar.They can be granted certain read-only access, such as the ability to view APIs but not call them.

Para além destes grupos de sistema, os administradores podem criar grupos personalizados ou tirar partido de grupos externos em inquilinos do Azure Active Directory associados.In addition to these system groups, administrators can create custom groups or leverage external groups in associated Azure Active Directory tenants. É possível utilizar grupos personalizados e externos em conjunto com grupos de sistema para dar aos programadores acesso e visibilidade a produtos de API.Custom and external groups can be used alongside system groups in giving developers visibility and access to API products. Por exemplo, pode criar um grupo personalizado para os programadores associados a uma organização parceira específica e permitir-lhes o acesso às APIs a partir de um produto que contém apenas APIs relevantes.For example, you could create one custom group for developers affiliated with a specific partner organization and allow them access to the APIs from a product containing relevant APIs only. Um utilizador pode ser membro de mais do que um grupo.A user can be a member of more than one group.

Para obter mais informações, consulte Como criar e utilizar grupos.For more information, see How to create and use groups.

Programadores Developers

Os programadores representam as contas de utilizador numa instância de serviço de API Management.Developers represent the user accounts in an API Management service instance. Os programadores podem ser criados ou convidados a aderirem por administradores, ou podem inscrever-se a partir do Portal do programador.Developers can be created or invited to join by administrators, or they can sign up from the Developer portal. Cada programador é membro de um ou mais grupos e pode subscrever os produtos que concedem visibilidade a esses grupos.Each developer is a member of one or more groups, and can subscribe to the products that grant visibility to those groups.

Quando os programadores subscrevem um produto, é-lhes concedida a chave primária e secundária desse produto.When developers subscribe to a product, they are granted the primary and secondary key for the product. Esta chave é utilizada ao efetuar chamadas para as APIs do produto.This key is used when making calls into the product's APIs.

Para obter mais informações, consulte Como criar ou convidar programadores e Como associar grupos a programadores.For more information, see How to create or invite developers and How to associate groups with developers.

Políticas Policies

As políticas são uma funcionalidade poderosa da Gestão de API que permite ao portal do Azure alterar o comportamento da API através da configuração.Policies are a powerful capability of API Management that allow the Azure portal to change the behavior of the API through configuration. As políticas são uma coleção de instruções que são executadas sequencialmente no pedido ou na resposta de uma API.Policies are a collection of statements that are executed sequentially on the request or response of an API. As instruções populares incluem a conversão do formato de XML para JSON e a limitação de taxa de chamadas para restringir o número de chamadas recebidas de um programador, bem como várias outras políticas disponíveis.Popular statements include format conversion from XML to JSON and call rate limiting to restrict the number of incoming calls from a developer, and many other policies are available.

As expressões de política podem ser utilizadas como valores de atributo ou valores de texto em qualquer uma das políticas de API Management, a menos que a política especifique o contrário.Policy expressions can be used as attribute values or text values in any of the API Management policies, unless the policy specifies otherwise. Algumas políticas, como Fluxo de controlo e Definir variável, baseiam-se em expressões de política.Some policies such as the Control flow and Set variable policies are based on policy expressions. Para obter mais informações, veja Políticas avançadas e Expressões de política.For more information, see Advanced policies and Policy expressions.

Para obter uma lista completa das políticas de API Management, consulte Referência de política.For a complete list of API Management policies, see Policy reference. Para obter mais informações sobre como utilizar e configurar as políticas, consulte Políticas de API Management.For more information on using and configuring policies, see API Management policies. Para consultar um tutorial sobre a criação de um produto com políticas de limite de taxa e quota, consulte Como criar e configurar definições de produto avançadas.For a tutorial on creating a product with rate limit and quota policies, see How create and configure advanced product settings.

Portal do programador Developer portal

O portal do programador é o local onde os programadores podem saber mais sobre as suas APIs, ver e chamar operações e subscrever produtos.The developer portal is where developers can learn about your APIs, view and call operations, and subscribe to products. Os potenciais clientes podem visitar o portal do programador, ver APIs e operações e inscrever-se.Prospective customers can visit the developer portal, view APIs and operations, and sign up. O URL do seu portal do programador está localizado no dashboard do portal do Azure da sua instância de serviço de Gestão de API.The URL for your developer portal is located on the dashboard in the Azure portal for your API Management service instance.

Pode personalizar o aspeto e a funcionalidade do portal do programador ao adicionar conteúdo personalizado, personalizar os estilos e adicionar a sua imagem corporativa.You can customize the look and feel of your developer portal by adding custom content, customizing styles, and adding your branding.

API Management e a economia da APIAPI Management and the API economy

Para obter mais informações sobre a Gestão de API, veja a seguinte apresentação da conferência Microsoft Ignite 2017.To learn more about API Management, watch the following presentation from the Microsoft Ignite 2017 conference.

Passos seguintesNext steps

Conclua o guia de início rápido seguinte e comece a utilizar a Gestão de API do Azure:Complete the following quickstart and start using Azure API Management: