Grundbegriffe

Eine "Application Programming Interface" ist eine Schnittstelle, mit der eine Anwendung problemlos Funktionen oder Daten aus einer anderen Anwendung nutzen kann.

Durch die Definition stabiler, vereinfachter Einstiegspunkte für Anwendungslogik und -daten können Entwickler auf die von anderen Entwicklern erstellte Anwendungslogik zugreifen und diese wiederverwenden. Bei Web APIs werden diese Logik und Daten über das Netzwerk bereitgestellt. Da Anwendungen, die APIs verwenden, auf Änderungen empfindlich reagieren, schließen APIs auch einen Vertrag ein. Der Vertrag sorgt für ein gewisses Maß an Sicherheit, dass sich die API im Laufe der Zeit auf vorhersehbare Weise verändert.

Apigee bietet eine Fülle von Informationen zu APIs und Best Practices für deren Entwicklung und Nutzung. Sehen Sie sich zum Einstieg den Webcast zum API-Design an oder laden Sie das kostenlose E-Book Web API Design: The Missing Link Best Practices for Crafting Interfaces that Developers Love herunter.

Eine Fassade in Edge für eine oder mehrere APIs, allgemeine HTTP-Dienste oder Anwendungen (z. B. Node.js).

Ein API-Proxy wird als ein Satz von Konfigurationsdateien, Richtlinien und Code implementiert, der auf einer Reihe von Ressourcen basiert, die von Apigee Edge bereitgestellt werden. API-Proxys können über die Apigee Edge-Management-Benutzeroberfläche generiert und konfiguriert oder sie können lokal in einem Texteditor oder IDE implementiert werden.

Die von einem API-Proxy bereitgestellte Fassade entkoppelt die Entwickler-API von Back-End-Diensten, schützt Entwickler vor Codeänderungen und ermöglicht Innovationen am Edge, ohne dass dies Auswirkungen auf Ihre internen Entwicklungsteams hat. Wenn Entwicklerteams Back-End-Änderungen vornehmen, rufen Entwickler weiterhin dieselbe Schnittstelle ohne Unterbrechungen auf. Mit Apigee können Sie mehrere Schnittstellen für dieselbe API bereitstellen, sodass Sie die Signatur einer API anpassen können, um den Anforderungen verschiedener Entwicklernischen gleichzeitig gerecht zu werden.

Durch Netzwerkadressen und URIs definierte APIs. Eine API besteht aus einem Basispfad und einer Reihe von API-Ressourcen. Jeder API-Proxy definiert einen Basispfad und optional mehrere API-Ressourcenpfade. Sie können sich eine API einfach als eine Gruppe von URIs vorstellen, die alle einen gemeinsamen Basispfad haben.

Um die Verwaltung Ihrer APIs zu vereinfachen, erweitert Apigee diese Roh-URIs durch Anzeigenamen und Beschreibungen. Mit Edge können Sie Richtlinien und Code an URIs anhängen und so das Verhalten Ihrer APIs detailliert steuern und verwalten.

Eine Sammlung von API-Ressourcen (URIs) in Kombination mit einem Kontingent oder Serviceplan, die Entwicklern während der Entwicklungsphase zur Verfügung gestellt wird. API-Produkte können wiederum in API-Pakete zur Monetarisierung gebündelt werden.

Ein API-Schlüssel ist an ein oder mehrere API-Produkte gebunden, wodurch eine Bindung zwischen einer App und dem Bündel von URIs erzwungen wird, die die App verwenden darf.

Eine Abkürzung von application (Anwendung). Der Begriff App bezieht sich auf mobile Anwendungen, die APIs nutzen. Entwickler implementieren Anwendungen in einer Vielzahl von Programmiersprachen und nutzen verschiedene Technologien und Plattformen. Entwickler, die APIs nutzen möchten, registrieren Anwendungen in der Organisation eines API-Anbieters bei Apigee Edge.

Wenn die Anwendung registriert ist, generiert Apigee einen API-Schlüssel und ein Secret, die die Anwendung identifizieren. Der Entwickler bettet den API-Schlüssel in die Anwendung ein, wodurch der Schlüssel bei Anfragen präsentiert wird. API-Dienste implementieren Sicherheit für den API-Schlüssel über eine direkte API-Schlüsselvalidierung oder über OAuth.

Ein Laufzeitausführungskontext für API-Proxys. Ein API-Proxy muss in einer Umgebung bereitgestellt werden, bevor die API über das Netzwerk zugänglich ist. Standardmäßig werden Organisationen mit zwei Umgebungen bereitgestellt: test und prod.

• Die test-Umgebung wird normalerweise zur Bereitstellung von API-Proxys während der Entwicklung verwendet.
• Die prod-Umgebung wird normalerweise zum Hochstufen von API-Proxys aus der Testumgebung verwendet, nachdem sie vollständig entwickelt und getestet wurden.

Ein Container für alle Objekte in einem Apigee Edge-Konto, einschließlich API-Proxys, API-Produkten, API-Paketen, Anwendungen und Entwicklern.

Für jede Organisation, der Sie angehören, ist ein Nutzerkonto erforderlich. Die meisten Nutzer haben nur ein Konto in nur einer Organisation.

Einen Verarbeitungsschritt, der als atomare, wiederverwendbare Logikeinheit innerhalb eines API-Proxy-Verarbeitungsablaufs ausgeführt wird.

Zu den typischen richtlinienbasierten Funktionen gehören die Umwandlung von Nachrichtenformaten, die Zugriffskontrolle, Remote-Dienste für zusätzliche Informationen, das Maskieren sensibler Daten von externen Nutzern, die Untersuchung von Nachrichteninhalten auf potenzielle Bedrohungen, die Speicherung häufiger Antworten sowie die Leistungssteigerung etc.

Richtlinien können basierend auf dem Inhalt oder Kontext einer Anfrage oder Antwortnachricht bedingt ausgeführt werden. Zum Beispiel kann eine Transformationsrichtlinie ausgeführt werden, um ein Antwortformat anzupassen, wenn die Anfragenachricht von einem Smartphone gesendet wurde.

Die Version der API-Schnittstelle für Entwickler.

Beispiel: pivotaltracker.com/services/v3, oder api.enterprise.apigee.com/v1.

Dieser Begriff unterscheidet sich von Revision, dem nummerierten, versionierten Paket mit Konfiguration und Richtlinien eines API-Proxys. API-Schnittstellen haben Versionen; API-Proxys haben Revisionen.