Wie verwendet man die API?

8 Min. Lesezeit

Ich habe früher im Kundenservice eines Technologieunternehmens gearbeitet, in dem API-Verbindungen, die Benutzerdaten aus anderen Programmen extrahieren, ein integraler Bestandteil des Produkts waren. Wenn ich den Kunden erklärte, warum wir auf ein bestimmtes Datenelement nicht zugreifen konnten, empfahlen die Entwickler oft die Antwort: „Es ist nicht über die API verfügbar.“

Damals dachte ich, eine API sei wie ein USB-Anschluss, und indem wir uns mit diesem Anschluss verbinden, hätten wir Zugriff auf alles in einem anderen Programm. Es stellte sich heraus, dass ich falsch lag.

A découvrir également : Wie man das große C mit Cedille in Ihrem Text verwendet?

Siehe auch: Zapier vs IFTTT: Das beste Tool zur Automatisierung von Aufgaben

APIs sind weniger wie USB-Anschlüsse oder Feuerwehrschläuche, als sie wie eine Person in einem Support-Center in einem fremden Land sind. Eine API gibt Ihnen nicht alle Informationen oder den Code eines Programms (wie ein Feuerwehrschlauch), denn was würde Sie daran hindern, die gesamte Codebasis zu replizieren? Stattdessen stellt eine API Daten zur Verfügung, die ihre Programmierer für externe Benutzer zugänglich gemacht haben. Dennoch müssen Sie wissen, wie Sie die richtigen Fragen stellen, um irgendetwas mit diesen Daten zu tun.

A lire aussi : Wie trägt man eine Jeans richtig?

Was ist eine API?

API steht für Application Programming Interface. Der wichtigste Teil dieses Namens ist „Schnittstelle“, denn eine API spricht im Wesentlichen mit einem Programm für Sie. Sie müssen immer die Sprache kennen, um mit dem Programm zu kommunizieren, aber ohne API kommen Sie nicht weit.

Wenn Programmierer entscheiden, bestimmte Daten öffentlich zugänglich zu machen, „stellen sie Endpunkte bereit“, was bedeutet, dass sie einen Teil der Sprache veröffentlichen, die sie verwendet haben, um ihr Programm zu erstellen. Andere Programmierer können dann Daten aus der Anwendung extrahieren, indem sie URLs erstellen oder HTTP-Clients (spezielle Programme, die die URLs für Sie erstellen) verwenden, um Daten von diesen Endpunkten anzufordern.

Die Endpunkte geben Text zurück, der für Computer lesbar ist, sodass es keinen Sinn macht, wenn Sie den verwendeten Computer-Code nicht verstehen.

TL; DR: Eine API ermöglicht es einem Programm, Daten von einem anderen anzufordern.

Warum eine API verwenden

Computer erleichtern viele Dinge, insbesondere Aufgaben, die das Sammeln und Sortieren von Unmengen an Daten beinhalten. Angenommen, Sie möchten wissen, wie oft ein Dritter Rechnungen an Ihr Unternehmen eingereicht hat. Es wäre möglich, in die Rechnungsunterlagen Ihres Unternehmens zu gehen, den Datenpunkt „von“ zu scannen und jede Rechnung einzeln für Ihr Audit auszudrucken.

Andererseits, wenn alle Rechnungen in einer zentralen Datenbank hochgeladen wurden, können Sie ein einfaches Programm schreiben, das auf diese Datenbank zugreift und alle Instanzen des Partnernamens findet. Das würde viel weniger Zeit in Anspruch nehmen und wäre viel genauer.

Architektur einer API

APIs bestehen aus drei Teilen:

  • Benutzer: die Person, die eine Anfrage stellt
  • Client: Computer, der die Anfrage an den Server sendet
  • Server: der Computer, der auf die Anfrage antwortet

Jemand wird zuerst den Server aufbauen, da er Daten erwirbt und speichert. Sobald dieser Server läuft, veröffentlichen die Programmierer Dokumentationen, einschließlich der Endpunkte, an denen spezifische Daten gefunden werden können. Diese Dokumentation zeigt externen Programmierern die Struktur der Daten auf dem Server. Ein externer Benutzer kann dann die Daten auf dem Server abfragen (oder suchen) oder ein Programm erstellen, das Abfragen in der Datenbank ausführt und diese Informationen in ein anderes, verwendbares Format umwandelt.

Das ist ziemlich verwirrend, also nehmen wir ein reales Beispiel: ein Adressbuch.

In der analogen Zeit würden Sie eine Kopie des Telefonbuchs der Telefonanbieter erhalten, das alle Personen in Ihrer Stadt nach Namen und Adresse in alphabetischer Reihenfolge auflistete. Wenn Sie die Adresse eines Freundes benötigen, können Sie sie nach Nachnamen suchen, die Adresse finden und dann ihre Straße auf den Karten auf der Rückseite suchen. Es handelte sich um eine begrenzte Menge an Informationen, und der Zugriff dauerte viel Zeit. Jetzt, dank der Magie der Technologie, können all diese Informationen in einer Datenbank gefunden werden.

Lasst uns eine Datenbank erstellen, die die Seiten der weißen Seiten für eine fiktive Stadt namens Happyville enthält. Die Leute von HappyVille_WP haben beschlossen, dass sie beim Aufbau ihrer Datenbank einige Kategorien von Informationen mit verschachtelten Daten darunter erstellen würden. Das sind unsere Endpunkte, und sie werden alle Informationen enthalten, die die API einem externen Programm zur Verfügung stellen wird.

Hier sind die Endpunkte, die in der Dokumentation von HappyVille_WP aufgeführt sind:

  • /namen
    • /vorname, /nachname
  • /adressen
    • /strassenadresse, /email_adresse/
  • /telefone
    • /festnetztelefon, /handy

Offensichtlich sind dies nicht alle Informationen, die über eine Person gesammelt werden können. Selbst wenn HappyVille_WP privatere Informationen über die Bewohner von Happyville (wie Geburtsdaten und Sozialversicherungsnummern) sammeln würde, wären diese Daten für externe Programmierer nicht verfügbar, ohne die Sprache dieser Endpunkte zu kennen.

Diese Endpunkte zeigen Ihnen die Sprache, die Sie verwenden müssen, um Informationen aus der Datenbank anzufordern. Wenn Sie eine Liste aller Menschen in Happyville mit dem Nachnamen Smith möchten, können Sie eine der beiden folgenden Dinge tun:

  1. Eine URL-Anfrage in einem Browser für diese Information stellen. Dies nutzt Ihren Internetbrowser als Client, und Sie erhalten ein Textdokument in Codierungssprache zum Sortieren. Diese URL könnte so aussehen: http://api.happyville_wp.com/names?last_name=smith
  2. Ein Programm verwenden, das die Informationen anfordert und sie in ein verwendbares Format übersetzt. Sie können Ihr eigenes Programm codieren oder einen fertigen HTTP-Client verwenden.

Die erste Option ist ideal für einfache Anfragen mit nur wenigen Antworten (alle Personen in Happyville mit dem Nachnamen Xarlax, zum Beispiel – ich bin mir ziemlich sicher, dass es nur sechs Haushalte mit diesem Namen in Happyville gibt). Die zweite Option erfordert mehr Programmierkenntnisse, ist aber ideal für Programmierer, die die Datenbank eines anderen Programms nutzen möchten, um ihre eigenen Anwendungen zu verbessern.

Viele Unternehmen nutzen die offenen APIs großer Unternehmen wie Google und Facebook, um auf Daten zuzugreifen, die sonst möglicherweise nicht verfügbar wären. In diesem Fall senken APIs erheblich die Eintrittsbarrieren für kleine Unternehmen, die sonst ihre eigenen Daten zusammenstellen müssten.

Aktionen, die Sie über eine API durchführen können

Wow! Also ist eine API die Art und Weise, wie zwei Computer miteinander sprechen. Der Server hat die Daten und definiert die Sprache, während der Client diese Sprache verwendet, um Informationen vom Server anzufordern (zur Info, Server senden keine Daten, ohne dass ein Client Daten anfordert, aber Entwickler haben Wege gefunden, dies mit Webhooks zu umgehen). APIs können alles tun!

Nicht so schnell. Die Sprache und Syntax von APIs schränken ihre Fähigkeiten erheblich ein. Es gibt vier Arten von Aktionen, die eine API durchführen kann:

  • GET: fordert Daten von einem Server an – kann ein Status oder spezifische Details (wie last_name) sein
  • POST: sendet die Änderungen des Clients an den Server; denken Sie daran, dies als Hinzufügen von Informationen zum Server, wie das Erstellen eines neuen Eintrags
  • PUT: überarbeitet oder fügt vorhandene Informationen hinzu
  • DELETE: löscht vorhandene Informationen

Wenn Sie die Endpunkte mit diesen Aktionen kombinieren, können Sie alle über eine API verfügbaren Informationen abfragen oder aktualisieren. Sie müssen die Dokumentation der API überprüfen, um zu erfahren, wie Sie diese Aktionen codieren, da sie alle unterschiedlich sind.

Während wir über Sprache und Syntax sprechen, werden wir die Möglichkeiten, wie Sie eine Anfrage an einen Server stellen können abdecken:

HTTP: Hypertext Transfer Protocol. So sind Sie überhaupt erst auf unsere Website gekommen, indem Sie eine URL in die Suchleiste Ihres Browsers eingegeben haben. Es ist eine wirklich einfache Möglichkeit, auf Daten zuzugreifen, aber es wird Ihnen nicht in einem schönen Format zurückgegeben, wenn Sie viele Informationen anfordern. Wir werden gleich näher darauf eingehen.

Textformate: XML, JSON. Dies sind die Hauptsprachen, um über eine API auf Daten zuzugreifen. Wenn Sie Ihre Daten erhalten, müssen Sie den XML- oder JSON-Code durchgehen, um zu verstehen, was der Server Ihnen gegeben hat.

Beginnen Sie mit der Verwendung einer API

Die meisten API-Nutzungen, die Sie in Ihrem beruflichen Alltag sehen werden, bewegen Informationen von einem Programm zu ähnlichen Formularfeldern in einem anderen Programm. Dies ist besonders nützlich, wenn Sie versuchen, Informationen zu teilen, die Sie sonst mehrfach eingeben müssten – zum Beispiel das Teilen von Leads zwischen Ihrer Marketing-Automatisierungsplattform und Ihrem CRM.

Die Anwendungen und Beispiele, die wir hier auflisten werden, sind viel grundlegender und nutzen viel weniger, als Ihre Standard-API kann. Aber sie geben Ihnen eine gute Vorstellung von den Schritten im API-Prozess.

  1. Die meisten APIs erfordern einen API-Schlüssel. Sobald Sie eine API gefunden haben, mit der Sie spielen möchten, schauen Sie sich die Dokumentation an, um die Zugangsbedingungen zu erfahren. Die meisten APIs verlangen von Ihnen, dass Sie eine Identitätsüberprüfung durchführen, wie sich mit Ihrem Google-Konto anzumelden. Sie erhalten eine einzigartige Zeichenfolge aus Buchstaben und Zahlen, die Sie beim Zugriff auf die API verwenden, anstatt jedes Mal einfach Ihre E-Mail-Adresse und Ihr Passwort hinzuzufügen (was nicht sehr sicher ist – für weitere Informationen zu Berechtigungen und Überprüfungen lesen Sie dies).
  2. Die einfachste Möglichkeit, mit einer API zu beginnen, besteht darin, einen HTTP-Client online zu finden, wie REST-Client, Postman oder Paw. Diese einsatzbereiten (und oft kostenlosen) Tools helfen Ihnen, Ihre Anfragen zum Zugriff auf bestehende APIs mit dem API-Schlüssel, den Sie erhalten haben, zu strukturieren. Sie müssen immer noch einen Teil der Syntax aus der Dokumentation kennen, aber es sind sehr wenige Programmierkenntnisse erforderlich.
  3. Die beste Möglichkeit, Daten aus einer API zu extrahieren, besteht darin, eine URL aus der bestehenden Dokumentation der API zu erstellen. Dieses YouTube-Video erklärt, wie man Standortdaten von Google Maps über die API extrahiert und dann diese Koordinaten verwendet, um nahegelegene Fotos auf Instagram zu finden.

Insgesamt sieht eine API-Anfrage nicht sehr anders aus als eine normale URL im Browser, aber die zurückgegebenen Daten werden in einem für Computer leicht lesbaren Format sein. Hier ist, was passiert ist, als ich Informationen aus der OpenWeather-Datenbank in meinem Webbrowser angefordert habe:

Beispiel-URL aus der Dokumentation – fordert das Wetter für eine bestimmte Stadt an:

api.openweathermap.org/data/2.5/weather?q={stadtname}

Geben Sie in Ihrem Browser ein:

api.openweathermap.org/data/2.5/weather?q=Nashville,TN&APIID={zahlenbuchstaben}

Fazit und weiterführende Literatur

Eine API ist nützlich, um spezifische Informationen aus einem anderen Programm zu extrahieren. Wenn Sie die Dokumentation lesen und die Anfragen schreiben können, können Sie viele gute Daten abrufen, aber es kann überwältigend sein, all dies zu analysieren. Hier kommen die Entwickler ins Spiel. Sie können Programme erstellen, die Daten direkt in einer Anwendung oder einem Browserfenster in einem leicht konsumierbaren Format anzeigen.

Dieser Artikel kratzt kaum an der Oberfläche der API-Technologie. Ich habe ein wenig im Internet recherchiert, um mehr über APIs zu erfahren. Hier sind die Artikel und Videos, die mir am meisten geholfen haben:

  • APIs nutzen: nicht ganz so schwer, wie es scheint
  • Wie man APIs mit JavaScript verwendet
  • Web-APIs für Nicht-Programmierer
  • Zapier API-Kurs
  • REST API Konzepte und Beispiele
  • Was sind APIs und warum sind sie wichtig

Sie möchten Ihre Programme verbinden, haben aber keine Zeit, einen Client zu erstellen? Es gibt viele Unternehmen, die bestehende APIs verbinden oder maßgeschneiderte Verbindungen für Sie erstellen. Diese können von einfachen, datengestützten Anwendungen wie Zapier bis hin zu groß angelegten Business-Intelligence-Integrationen reichen, die riesige Datenmengen aus mehreren Quellen für Analysen ziehen. Zu wissen, wie eine API funktioniert, ist der erste Schritt, um großartige Integrationen zu erstellen.

Lesen Sie weiter auf blog-introduction.fr

Wie verwendet man die API?