Informationen zu API ManagementAbout API Management

Mit API Management (APIM) können Sie konsistente und moderne API-Gateways für vorhandene Back-End-Dienste erstellen.API Management (APIM) is a way to create consistent and modern API gateways for existing back-end services.

API Management unterstützt Organisationen beim Veröffentlichen von APIs für externe Entwickler, Partnerentwickler und interne Entwickler, um das volle Potenzial von Daten und Diensten ausschöpfen zu können.API Management helps organizations publish APIs to external, partner, and internal developers to unlock the potential of their data and services. Unternehmen sind weltweit dabei, ihren Betrieb als digitale Plattform zu erweitern, neue Kanäle zu erschließen, neue Kunden zu finden und die Bindung zu existierenden Kunden zu vertiefen.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. API Management bietet die Kernkompetenzen zur Sicherstellung eines erfolgreichen API-Programms in Form von Entwicklerengagement, geschäftlichen Erkenntnissen, Analysen, Sicherheit und Schutz.API Management provides the core competencies to ensure a successful API program through developer engagement, business insights, analytics, security, and protection. Mithilfe von Azure API Management können Sie ein API-Programm mit vollem Funktionsumfang auf einem beliebigen Back-End starten.You can use Azure API Management to take any backend and launch a full-fledged API program based on it.

Dieser Artikel enthält eine Übersicht über allgemeine Szenarien mit APIM.This article provides an overview of common scenarios that involve APIM. Außerdem finden Sie hier eine Kurzübersicht über die Hauptkomponenten des APIM-Systems.It also gives a brief overview of the APIM system's main components. Im Anschluss werden die einzelnen Komponenten ausführlicher behandelt.The article, then, gives a more detailed overview of each component.

ÜbersichtOverview

Administratoren erstellen APIs, um API Management zu nutzen.To use API Management, administrators create APIs. Jede API besteht aus einer oder mehreren Operationen, und jede API kann zu einem oder mehreren Produkten hinzugefügt werden.Each API consists of one or more operations, and each API can be added to one or more products. Um eine API zu nutzen, abonnieren Entwickler ein Produkt, das diese API enthält. Anschließend können sie die Operationen der API aufrufen und unterliegen dabei allen geltenden Nutzungsrichtlinien.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. Zu den häufigen Szenarios gehören:Common scenarios include:

  • Schutz einer mobilen Infrastruktur durch Einschränkung des Zugriffs mit API-Schlüsseln, das Verhindern von DOS-Angriffen über eine Drosselung oder das Verwenden erweiterter Sicherheitsrichtlinien wie z. B. der JWT-Tokenüberprüfung.Securing mobile infrastructure by gating access with API keys, preventing DOS attacks by using throttling, or using advanced security policies like JWT token validation.
  • Bereitstellung eines ISV-Partnerökosystems durch eine schnelle Partnerintegration über das Entwicklerportal und das Erstellen einer API-Fassade zum Entkoppeln interner Implementierungen, die noch nicht für die Partnernutzung geeignet sind.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.
  • Ausführung eines internen API-Programms durch Bereitstellung einer zentralen Stelle innerhalb der Organisation für den Austausch über Verfügbarkeit und neueste Änderungen an APIs, Einschränkung des Zugriffs basierend auf Organisationskonten – all dies basierend auf einem sicheren Kanal zwischen API-Gateway und 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.

Das System setzt sich aus den folgenden Komponenten zusammen:The system is made up of the following components:

  • Das API-Gateway ist der Endpunkt, der folgende Aufgaben übernimmt:The API gateway is the endpoint that:

    • Akzeptieren von API-Aufrufen und Weiterleiten dieser Aufrufe an Ihre Back-EndsAccepts API calls and routes them to your backends.
    • Überprüfen von API-Schlüsseln, JWT-Token, Zertifikaten und anderen AnmeldeinformationenVerifies API keys, JWT tokens, certificates, and other credentials.
    • Erzwingen von Nutzungskontingenten und ÜbertragungsratenlimitsEnforces usage quotas and rate limits.
    • Dynamisches Transformieren Ihrer API ohne CodeänderungenTransforms your API on the fly without code modifications.
    • Zwischenspeichern von Back-End-Antworten, falls eingerichtetCaches backend responses where set up.
    • Protokollieren von Aufrufmetadaten zu AnalysezweckenLogs call metadata for analytics purposes.
  • Das Azure-Portal ist die Verwaltungsoberfläche, über die Sie Ihr API-Programm einrichten.The Azure portal is the administrative interface where you set up your API program. Verwenden Sie es zu folgenden Zwecken:Use it to:

    • Definieren oder Importieren des API-SchemasDefine or import API schema.
    • Paketieren von APIs in ProduktenPackage APIs into products.
    • Konfigurieren von Richtlinien wie z. B. Kontingenten oder Transformationen für die APIsSet up policies like quotas or transformations on the APIs.
    • Gewinnen von Erkenntnissen mithilfe von AnalysenGet insights from analytics.
    • Verwalten von BenutzernManage users.
  • Das Entwicklerportal dient als wichtigste Webpräsenz für Entwickler und ermöglicht Folgendes:The Developer portal serves as the main web presence for developers, where they can:

    • Lesen der API-DokumentationRead API documentation.
    • Ausprobieren einer API mithilfe der interaktiven KonsoleTry out an API via the interactive console.
    • Erstellen eines Kontos und Anfordern von API-SchlüsselnCreate an account and subscribe to get API keys.
    • Zugriff auf NutzungsanalysenAccess analytics on their own usage.

Weitere Informationen finden Sie im Whitepaper Cloud-based API Management: Harnessing the Power of APIs (Cloudbasierte API-Verwaltung: Nutzung der Leistung von APIs).For more information, see the Cloud-based API Management: Harnessing the Power of APIs PDF whitepaper. In diesem Whitepaper zu API Management von CITO Research werden folgende Themen behandelt:This introductory whitepaper on API Management by CITO Research covers:

  • Allgemeine API-Anforderungen und -HerausforderungenCommon API requirements and challenges
  • Entkoppeln von APIs und Präsentieren von FassadenDecoupling APIs and presenting facades
  • Schnelle Einrichtung und Inbetriebnahme durch EntwicklerGetting developers up and running quickly
  • Sichern des ZugriffsSecuring access
  • Analysen und MetrikenAnalytics and metrics
  • Kontrolle und Einblick mit einer API Management-PlattformGaining control and insight with an API Management platform
  • Verwenden von Cloudlösungen im Vergleich zu lokalen LösungenUsing cloud vs on-premises solutions
  • Azure API ManagementAzure API Management

APIs und Operationen APIs and operations

APIs sind die Grundlage einer API Management-Dienstinstanz.APIs are the foundation of an API Management service instance. Jede API stellt Entwicklern einen Satz von Operationen zur Verfügung.Each API represents a set of operations available to developers. Jede API enthält einen Verweis auf den Back-End-Dienst, der die API implementiert, und die Operationen der API sind den Operationen des Back-End-Diensts zugeordnet.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. Für Operationen in API Management ist eine umfangreiche Konfiguration möglich. Sie können die URL-Zuordnung, Abfrage- und Pfadparameter, Anforderungs- und Antwortinhalte sowie das Zwischenspeichern von Operationsantworten steuern.Operations in API Management are highly configurable, with control over URL mapping, query and path parameters, request and response content, and operation response caching. Durchsatzgrenzen, Kontingente und IP-Einschränkungen können ebenfalls auf API-Ebene oder für einzelne Operationen konfiguriert werden.Rate limit, quotas, and IP restriction policies can also be implemented at the API or individual operation level.

Weitere Informationen finden Sie unter Erstellen von APIs und Hinzufügen von Operationen zu einer API.For more information, see How to create APIs and How to add operations to an API.

Produkte Products

APIs werden in Form von Produkten an Entwickler bereitgestellt.Products are how APIs are surfaced to developers. Produkte in API Management enthalten eine oder mehrere APIs und werden mit einem Titel, einer Beschreibung und Nutzungsbedingungen konfiguriert.Products in API Management have one or more APIs, and are configured with a title, description, and terms of use. Produkte können Offen oder Geschützt sein.Products can be Open or Protected. Geschützte Produkte müssen abonniert werden, bevor Sie verwendet werden können, während offene Produkte ohne Abonnement genutzt werden können.Protected products must be subscribed to before they can be used, while open products can be used without a subscription. Wenn ein Produkt bereit für die Nutzung durch Entwickler ist, kann es veröffentlicht werden.When a product is ready for use by developers, it can be published. Nach der Veröffentlichung kann das Produkt (bei geschützten Produkten nach dem Abonnieren) durch die Entwickler angezeigt werden.Once it is published, it can be viewed (and in the case of protected products subscribed to) by developers. Die Genehmigung von Abonnements wird auf der Produktebene konfiguriert. Abonnements können entweder eine Genehmigung eines Administrators erfordern oder automatisch genehmigt werden.Subscription approval is configured at the product level and can either require administrator approval, or be auto-approved.

Gruppen dienen zur Verwaltung der Sichtbarkeit von Produkten für Entwickler.Groups are used to manage the visibility of products to developers. Produkte gewähren Sichtbarkeit für Gruppen, und Entwickler können alle Produkte anzeigen und abonnieren, die für die Gruppen sichtbar sind, in denen sie Mitglied sind.Products grant visibility to groups, and developers can view and subscribe to the products that are visible to the groups in which they belong.

Gruppen Groups

Gruppen dienen zur Verwaltung der Sichtbarkeit von Produkten für Entwickler.Groups are used to manage the visibility of products to developers. API Management umfasst folgende unveränderliche Systemgruppen:API Management has the following immutable system groups:

  • Administratoren – Azure-Abonnementadministratoren sind Mitglieder dieser Gruppe.Administrators - Azure subscription administrators are members of this group. Administratoren verwalten API Management-Dienstinstanzen und erstellen die APIs, Operationen und Produkte, die von den Entwicklern verwendet werden.Administrators manage API Management service instances, creating the APIs, operations, and products that are used by developers.
  • Entwickler – Zu dieser Gruppe gehören authentifizierte Benutzer des Entwicklerportals.Developers - Authenticated developer portal users fall into this group. Entwickler sind die Kunden, die Anwendungen unter Verwendung Ihrer APIs erstellen.Developers are the customers that build applications using your APIs. Entwickler erhalten Zugriff zum Entwicklerportal und erstellen Anwendungen, die die Operationen einer API aufrufen.Developers are granted access to the developer portal and build applications that call the operations of an API.
  • Gäste – Nicht authentifizierte Benutzer wie z. B. potenzielle Kunden, die das Entwicklerportal einer API Management-Instanz besuchen, fallen in diese Gruppe.Guests - Unauthenticated developer portal users, such as prospective customers visiting the developer portal of an API Management instance fall into this group. Sie können diesen Benutzern schreibgeschützten Zugriff gewähren, z.B. um die APIs anzuzeigen, jedoch nicht aufrufen zu können.They can be granted certain read-only access, such as the ability to view APIs but not call them.

Zusätzlich zu diesen Systemgruppen können Administratoren benutzerdefinierte Gruppen erstellen oder externe Gruppen in zugeordneten Azure Active Directory-Mandanten verwenden.In addition to these system groups, administrators can create custom groups or leverage external groups in associated Azure Active Directory tenants. Benutzerdefinierte und externe Gruppen können gemeinsam mit Systemgruppen verwendet werden, um API-Produkte für Entwickler sichtbar zu machen und ihnen den Zugriff auf die API-Produkte zu ermöglichen.Custom and external groups can be used alongside system groups in giving developers visibility and access to API products. Beispielsweise können Sie eine benutzerdefinierte Gruppe für Entwickler eines spezifischen Partnerunternehmens erstellen und diesen Entwicklern Zugriff auf die APIs über ein Produkt erteilen, das nur die relevanten APIs enthält.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. Ein Benutzer kann Mitglied von mehr als einer Gruppe sein.A user can be a member of more than one group.

Weitere Informationen finden Sie unter Erstellen und Verwenden von Gruppen.For more information, see How to create and use groups.

Entwickler Developers

Entwickler stellen die Benutzerkonten in einer API Management-Dienstinstanz dar.Developers represent the user accounts in an API Management service instance. Entwickler können von Administratoren erstellt oder eingeladen werden, oder sie können sich im Entwicklerportalanmelden.Developers can be created or invited to join by administrators, or they can sign up from the Developer portal. Jeder Entwickler ist Mitglied in einer oder mehreren Gruppen und kann die Produkte abonnieren, die für die entsprechenden Gruppen sichtbar sind.Each developer is a member of one or more groups, and can subscribe to the products that grant visibility to those groups.

Wenn Entwickler ein Produkt abonnieren, erhalten sie den primären und den sekundären Schlüssel für das Produkt.When developers subscribe to a product, they are granted the primary and secondary key for the product. Diese Schlüssel kommen bei den Aufrufen an die APIs des Produkts zum Einsatz.This key is used when making calls into the product's APIs.

Weitere Informationen finden Sie unter Erstellen und Einladen von Entwicklern und Zuordnen von Entwicklern zu Gruppen.For more information, see How to create or invite developers and How to associate groups with developers.

Richtlinien Policies

Richtlinien sind ein praktisches Werkzeug in API Management, mit dem das Azure-Portal das Verhalten der API mittels Konfiguration verändern kann.Policies are a powerful capability of API Management that allow the Azure portal to change the behavior of the API through configuration. Richtlinien sind eine Sammlung von Anweisungen, die sequenziell bei Anfragen oder Antworten einer API ausgeführt werden.Policies are a collection of statements that are executed sequentially on the request or response of an API. Häufig verwendete Anweisungen sind etwa Formatumwandlungen von XML nach JSON und Aufrufratenlimits, um die Anzahl eingehender Aufrufe von einem Entwickler zu beschränken. Darüber hinaus stehen noch viele weitere Richtlinien zur Verfügung.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.

Richtlinienausdrücke können als Attributwerte oder Textwerte in einer beliebigen API Management-Richtlinie verwendet werden, sofern in der Richtlinie nicht anders angegeben.Policy expressions can be used as attribute values or text values in any of the API Management policies, unless the policy specifies otherwise. Einige Richtlinien, beispielsweise Ablaufsteuerung und Variable festlegen, basieren auf Richtlinienausdrücken.Some policies such as the Control flow and Set variable policies are based on policy expressions. Weitere Informationen finden Sie unter Erweiterte Richtlinien und Richtlinienausdrücke.For more information, see Advanced policies and Policy expressions.

Eine vollständige Liste der Richtlinien für API Management finden Sie unter Gruppenrichtlinienreferenz.For a complete list of API Management policies, see Policy reference. Weitere Informationen zur Verwendung und Konfiguration von Richtlinien finden Sie unter Richtlinien für API Management.For more information on using and configuring policies, see API Management policies. Ein Lernprogramm zum Erstellen eines Produkts mit Richtlinien für Durchsatzgrenzen und Kontingente finden Sie unter Erstellen und Konfigurieren erweiterter Produkteinstellungen.For a tutorial on creating a product with rate limit and quota policies, see How create and configure advanced product settings.

Entwicklerportal Developer portal

Im Entwicklerportal können Entwickler auf Ihre APIs zugreifen, Operationen anzeigen und aufrufen und Produkte abonnieren.The developer portal is where developers can learn about your APIs, view and call operations, and subscribe to products. Potenzielle Kunden können das Entwicklerportal besuchen, APIs und Operationen anzeigen und sich anmelden.Prospective customers can visit the developer portal, view APIs and operations, and sign up. Sie finden die URL Ihres Entwicklerportals im Dashboard des Azure-Portals für Ihre API Management-Dienstinstanz.The URL for your developer portal is located on the dashboard in the Azure portal for your API Management service instance.

Sie können das Erscheinungsbild Ihres Entwicklerportals konfigurieren, indem Sie eigene Inhalte hinzufügen, Stilregeln anpassen und Ihr Markenbild einfügen.You can customize the look and feel of your developer portal by adding custom content, customizing styles, and adding your branding.

API Management und API-ÖkonomieAPI Management and the API economy

Weitere Informationen zu API Management finden Sie in der folgenden Präsentation von der Microsoft Ignite 2017-Konferenz.To learn more about API Management, watch the following presentation from the Microsoft Ignite 2017 conference.

Nächste SchritteNext steps

Absolvieren Sie das folgende Schnellstarttutorial, und beginnen Sie mit der Verwendung von Azure API Management:Complete the following quickstart and start using Azure API Management: