What Is an API? The Answer in 300 Words or Less

0
64
What Is an API? The Answer in 300 Words or Less

Als die Marketingbranche zum ersten Mal vom Outbound- zum Inbound-Marketing wechselte, gaben viele Vermarkter ihre alte Rolle als Content-Interruptor für neue als Content-Ersteller auf.

Diese Verschiebung führt jedoch immer noch zu Nachbeben. Um mit Ihren Mitbewerbern heute Schritt zu halten, müssen Sie verstehen, was APIs sind, wie sie in Ihre Content-Strategie integriert werden und welche sozialen Erkenntnisse sie auf Ihre Website bringen.

Keine Sorge – APIs scheinen kompliziert zu sein, aber am Ende dieses Beitrags wissen Sie, wie sie funktionieren und was ihre Verwendung bedeutet.Hier finden Sie eine kurze Definition einer API, gefolgt von einigen wichtigen Informationen darüber, wie eine API für Ihr Unternehmen funktioniert.

Was ist eine API?

Eine API, kurz für Application Programming Interface, besteht aus einer Reihe von Regeln. Um noch klarer zu sein, es ist ein Informationsmittler. APIs ermöglichen es einer Anwendung, Informationen aus einer Software zu extrahieren und diese Informationen in ihrer eigenen Anwendung oder manchmal für die Datenanalyse zu verwenden.

Im einfachsten Sinne ist eine API eine Blaupause, die es “Ihren Sachen” ermöglicht, mit “ihren Sachen” zu sprechen und mit ihnen zu arbeiten. In diesem Fall wird Ihr Material als API-Endpunkt bezeichnet.

Was ist ein API-Endpunkt?

Ein API-Endpunkt ist das digitale Ziel, an dem APIs Informationsanfragen von einer Webanwendung oder einem Server senden und eine Antwort erhalten und auf die Ressourcen zugreifen, die zur Ausführung ihrer Funktion erforderlich sind.

Klingt verwirrend? Keine Sorge – wir werden unten ein Beispiel durchgehen.

Beispiel für einen API-Endpunkt

Angenommen, Sie möchten öffentliche Tweets in Echtzeit streamen, um über ein bestimmtes Thema oder aktuelle Trends in der Welt informiert zu bleiben. Dann könnten Sie den gefilterten Stream-Endpunkt von Twitter verwenden. Die URL lautet: https://api.twitter.com/2/tweets/search/stream

Technisch muss auf einen API-Endpunkt nur mit dem Endpfad der Ressourcen-URL verwiesen werden. Der Basispfad, der allen Endpunkten gemeinsam ist, lautet https://api.twitter.com. Da dies gleich bleibt, müssen Sie es nicht weiter auflisten. Sie können stattdessen einfach den Endpunkt auflisten: / 2 / tweets / search / stream.

So testen Sie einen API-Endpunkt

Zum Testen eines API-Endpunkts stehen mehrere Online-Tools zur Verfügung. In diesem Beitrag erfahren Sie, wie Sie einen Test mit cURL einrichten. cURL ist ein Befehlszeilentool zum Übertragen von Daten, das mehrere Protokolle unterstützt, einschließlich HTTP. Es ist in der Lage, Anforderungen zu stellen, Daten abzurufen und Daten zu senden. Dies macht es zum perfekten Tool zum Anfordern von Informationen von APIs.

Verwenden wir ein Beispiel aus Twitter-eigene Dokumentation. Angenommen, Sie möchten über die Twitter-API auf dem Laufenden bleiben. Dann möchten Sie Tweets von Hauptkonten wie @TwitterDev und @TwitterAPI erhalten, sobald sie veröffentlicht sind. Und vielleicht möchten Sie nur Tweets, die Links zu Artikeln oder Dokumentationen enthalten, damit Sie so viel Kontext wie möglich erhalten.

In diesem Fall ist die Verwendung des gefilterten Stream-Endpunkts die perfekte Wahl. Damit der Endpunkt jedoch weiß, welche Art von Tweets Sie senden sollen, müssen Sie Filterkriterien definieren. Andernfalls möchten Sie nur jeden Tweet in Echtzeit sehen.

Filterkriterien werden in Form von Regeln auf den Endpunkt angewendet. Um diese Regeln zu erstellen, benötigen Sie eine Reihe von Operatoren. In diesem Beispiel können Sie zwei Operatoren verwenden – von: und hat: Links – um nur Tweets von bestimmten Konten zu sehen, die Links enthalten. Um den gefilterten Stream-Endpunkt anzuweisen, nur Tweets von den Konten @Twitterdev und @TwitterApi anzuzeigen, die Links enthalten, verwenden Sie die folgende Regel: “Von: twitterdev von: twitterapi hat: links”

Um diese Informationen vom gefilterten Stream-Endpunkt anzufordern, müssen Sie die richtige HTTP-Anforderung angeben, um der API mitzuteilen, welche Aktion ausgeführt werden soll. Es gibt vier Hauptoptionen. Schauen Sie sich jeweils eine kurze Beschreibung an:

  • GET: Eine Ressource abrufen
  • POST: Erstellen Sie eine Ressource
  • PUT: Aktualisieren Sie eine vorhandene Ressource
  • LÖSCHEN: Eine Ressource entfernen

In diesem Beispiel verwenden Sie die POST-Anforderung. Zusätzlich zur Aufnahme der oben genannten Regel in Ihre Anfrage geben Sie den Inhaltstyp und die Berechtigung an. Im Folgenden wird der Inhaltstyp als “application / json” definiert, sodass die Anforderung im Lightweight-Datenformat JavaScript Object Notation (JSON) gerendert wird. Um Ihre Anfrage zu authentifizieren, müssen Sie den Platzhaltertext $ BEARER_TOKEN durch den eindeutigen Text Ihrer App ersetzen Inhaber-Token, die in Ihrem Entwicklerportal generiert werden können.

curl -X POST ‘https://api.twitter.com/2/tweets/search/stream/rules’
-H “Inhaltstyp: application / json”
-H “Autorisierung: Inhaber $ BEARER_TOKEN” -d
‘{
“hinzufügen”: [
{“value”: “from:twitterdev from:twitterapi has:links”}
]
} ‘

Warum sind APIs wichtig?

Eine der ersten Fragen, die viele Vermarkter stellen, lautet: Warum teilen all diese Unternehmen ihre Daten offen und kostenlos?

Normalerweise lautet die Antwort: Skala. Wenn Softwareunternehmen wachsen, erkennen die Mitarbeiter in diesen Unternehmen schnell, dass sie mehr Ideen haben, als sie Zeit und Ressourcen haben, um sie zu entwickeln.

Durch die Erstellung von APIs lassen Unternehmen Entwickler von Drittanbietern Anwendungen erstellen, mit denen die Nutzung und Akzeptanz der Hauptplattform verbessert werden kann. Auf diese Weise kann ein Unternehmen ein Ökosystem aufbauen, das von den Daten seiner API abhängig wird – eine Dynamik, die häufig zu zusätzlichen Umsatzmöglichkeiten führt.

So verwenden Sie eine API

Um den Wert einer bestimmten API zu verstehen, muss im Wesentlichen verstanden werden, welche Informationen über eine API verfügbar sind und wie auf sie zugegriffen werden kann. Um herauszufinden, was eine bestimmte API für Sie tun kann, haben Sie zwei Möglichkeiten.

  1. Bitten Sie einen Webentwickler, sich eine API anzusehen und diese mit Ihnen zu besprechen.
  2. Recherchiere selbst. Wenn Sie keinen Zugriff oder kein Budget für die Verwendung eines Webentwicklers haben, ist dies eine ansprechende Option. Aber keine Panik – viele Onlinedienste verfügen über eine gute API-Dokumentation.

API-Dokumentation

Schauen wir uns als Beispiel den API-Referenzindex von Twitter an.

Twitter API Referenzindex

Ein Großteil des Wachstums von Twitter ist auf externe Entwickler zurückzuführen, und die erste Twitter-API wurde als Basis-Wiki gestartet. Seitdem hat es sich zu einem detaillierten Index von APIs entwickelt, anhand dessen ein erfahrener Vermarkter bestimmen kann, welche Informationen einem Entwickler in Form einer API zur Verfügung stehen könnten – – und wie Sie diese API in Ihre Website aufnehmen können.

Wenn Sie sich den Screenshot oben ansehen, sehen Sie, dass externen Entwicklern mehrere Kategorien von Informationen zur Verfügung stehen. Sobald Sie eine API ausgewählt haben, an der Sie interessiert sind, können Sie darauf klicken, um zu sehen, welche Informationen über diese API verfügbar sind. Schauen Sie sich unten den Tweet Timeline API-Endpunkt von Twitter an.

Twitters Tweet Timeline API-Endpunktdokumentation

In der obigen API-Dokumentation wird in der Tweet-Timeline-API von Twitter erläutert, wie Sie eine kurze Sammlung der neuesten Tweets aus der Timeline eines bestimmten Benutzers entnehmen und in anklickbarer Form auf Ihrer eigenen Website anzeigen können. Die API-Dokumentation enthält Einschränkungen des Tweet-Volumens, die Ressourcen-URL der API sowie Informationen darüber, was Sie über diese API anzeigen können und was nicht.

Anwenden der API auf Ihre Website

Wenn Sie die Ressourcen-URL der API zum Backend Ihrer Website hinzufügen, werden die von Ihnen angeforderten Informationen an das Frontend Ihrer Website zurückgegeben. So sieht das auf der New York Road Runners-Website aus, um für den New York City Marathon zu werben (mit ein paar benutzerdefinierten Designänderungen):

Auf der New York Road Runners-Website werden Tweets mithilfe der Twitter-API eingebettet

Sie können auch in der HubSpot-API-Dokumentation nachlesen, wie Sie Anwendungen und Integrationen mit Daten aus HubSpot erstellen können.

Eine letzte Einschränkung: Um die API eines Entwicklers offiziell verwenden zu können, muss Ihnen möglicherweise auch ein API-Schlüssel zugewiesen werden.

Was ist ein API-Schlüssel (Application Programming Interface)?

Ein API-Schlüssel ist die eindeutige Kennung, die einem API-Benutzer zugewiesen wird und angibt, dass er die Anwendungsprogrammierschnittstelle auf seiner Website verwenden darf. Viele Entwickler verlangen, dass Sie diesen Schlüssel anfordern, bevor Sie die API verwenden, während andere ihn Ihnen möglicherweise bei Ihrer ersten API-Anforderung zuweisen.

Stellen Sie sich Ihren API-Schlüssel als Ihr Authentifizierungstoken vor, das Sie zum Mitglied der Entwicklergemeinschaft erklärt. Tatsächlich identifiziert dieses Token, wofür Sie die API verwenden, und überprüft, ob Sie vom Eigentümer der API die Berechtigung erhalten haben, dieses Projekt auszuführen.

Seien Sie versichert, Ihr API-Schlüssel gewährt dem Entwickler keinen Zugriff auf persönliche Informationen über Sie.

APIs als Marketingplattform

Beim Marketing in einer Inbound-Welt geht es darum, dass Unternehmen nützliche Anwendungen und Dienste entwickeln, um die Kundenbindung aufrechtzuerhalten. Marken müssen nicht mehr zeitweise Werbung schalten, um zu Kommunikationskanälen für Verbraucher zu werden.

In diesem Prozess erleichtern APIs die Daten, die zur Lösung von Kundenproblemen erforderlich sind.

API-Beispiele

Wenn Sie wissen, welche Informationen über eine API verfügbar sind, können Sie feststellen, ob es sich lohnt, mit einem Entwickler zusammenzuarbeiten, um das Projekt weiter zu verfolgen. Hier sind zwei Beispiele.

Twitter Erwähnungen

Wenn Sie Tweets auf Ihrer Website anzeigen möchten, die Erwähnungen auf Twitter zu Artikeln aus Ihrem Blog enthalten, müssen Sie verstehen, ob Sie Tweets mit nur bestimmten URLs von der Twitter-API anfordern können.

YouTube Video Embedding

Wenn Sie mit der rechten Maustaste auf ein YouTube-Video auf youtube.com klicken und “Einbettungscode kopieren” auswählen, fordern Sie im Wesentlichen die Verwendung der YouTube-API auf Ihrer Website an. YouTube erleichtert der Öffentlichkeit das Einbetten von YouTube-Videos, um sie direkt auf anderen Websites abzuspielen.

API-Nutzungsbedingungen

Unabhängig vom Projekt ist es wichtig, dass Sie die Nutzungsbedingungen für eine API, die Sie für Ihre Website in Betracht ziehen, tatsächlich lesen und verstehen.

Die meisten APIs haben bestimmte Nutzungsbeschränkungen. Wenn Sie sich nicht die Zeit nehmen, die Einschränkungen einer API zu verstehen, an der Sie interessiert sind, können Sie mehr Zeit und Geld in die Entwicklung eines Marketing-Assets investieren, das unbrauchbar wird, sobald der API-Anbieter feststellt, dass Sie gegen die Nutzungsbedingungen der API verstoßen haben (und widerruft Ihren Zugang).

Aus diesem Grund haben die meisten APIs “Anruflimits”.

Was ist ein API-Aufruf?

Ein API-Aufruf, auch als API-Anforderung bezeichnet, ist eine Instanz eines Website-Eigentümers, der die Verwendung der API eines Entwicklers “aufruft”. Das Speichern der API, Anmeldungen auf der Entwickler-Website und Abfragen zur Anwendung gelten als API-Aufrufe.

Vor diesem Hintergrund gibt ein API-Aufruflimit an, wie oft Sie innerhalb eines bestimmten Zeitraums Informationen zu einer API von einem Webdienst anfordern können. Lesen Sie auch hier die Nutzungsbedingungen für alle APIs, die Sie verwenden möchten. Diese Dokumente sollten alle Einschränkungen sowie die angemessene Verwendung des Programms klar beschreiben.

Die Zukunft der APIs in der Wirtschaft

Die Entwicklung der APIs vorhandener Webdienste ist nur der Anfang. Wir leben in einer Welt, die jetzt offene und verfügbare Inhalte für alle erwartet – – Der natürliche Fortschritt besteht darin, dass Publisher selbst ihre eigenen APIs veröffentlichen, damit ihre Kunden daraufhin Anwendungen entwickeln können.

Die API-Freigabe gilt für alle Unternehmen – nicht nur für webbasierte Unternehmen, sondern für alle Unternehmen, die über ein webbasiertes Tool oder eine webbasierte Komponente ihrer Organisation verfügen. Offensichtlich könnte dieses Konzept einigen Organisationen Hürden bereiten, insbesondere der Rechtsabteilung. Sie müssen herausfinden, welche APIs am wertvollsten sind und wie Sie sie rechtmäßig und nachhaltig nutzen können.

Anmerkung des Herausgebers: Dieser Beitrag wurde ursprünglich im März 2013 veröffentlicht und aus Gründen der Vollständigkeit aktualisiert.

Bleiben Sie auf dem Laufenden bei Emerging Tech