Über 50 Fragen, die Sie zur API eines Anbieters stellen sollten, bevor Sie eine Plattform auswählen
Ein guter Freund und Mentor schrieb mir eine Frage und ich möchte meine Antworten für diesen Beitrag verwenden. Seine Fragen konzentrierten sich mehr auf eine Branche (E-Mail), daher habe ich meine Antworten verallgemeinert. Er fragte, welche Fragen ein Unternehmen einem Anbieter über seine Anwendungsprogrammierschnittstelle API vor der Auswahl.
Warum benötigen Sie APIs?
APIs sind entscheidend für die nahtlose Integration zwischen verschiedenen Systemen, Anwendungen und Diensten. Wenn Sie beispielsweise eine mobile App verwenden, um das Wetter abzurufen, kommuniziert die App normalerweise mit der API eines externen Dienstes, um aktuelle Wetterdaten abzurufen. Ein weiteres gängiges Beispiel sind Social-Media-Plattformen, die es Entwicklern ermöglichen, Funktionen wie das Teilen oder Posten von Inhalten aus anderen Apps zu integrieren.
So wie Sie eine URL und eine Antwort auf einer Webseite zu erhalten, ist eine API eine Methode, mit der Ihre Systeme eine Antwort anfordern und erhalten können, um Daten zwischen ihnen zu synchronisieren. Während Unternehmen versuchen, sich zu verändern, ist die digitale Automatisierung von Aufgaben durch APIs eine großartige Möglichkeit, die organisatorische Effizienz zu verbessern und menschliche Fehler zu reduzieren.
APIs sind für die Automatisierung, insbesondere in Marketinganwendungen, von zentraler Bedeutung. Eine Herausforderung bei der Suche nach einem guten Anbieter mit einem umfassenden API ist, dass Entwicklungsressourcen und -ausgaben normalerweise eine Nebenrolle spielen. Das Marketingteam oder Business Development kann den Kauf einer Anwendung vorantreiben, und manchmal erhält das Entwicklungsteam nicht viel Input.
Welche Arten von APIs gibt es?
Es gibt viele verschiedene Arten von API-Technologien, jede mit ihren eigenen spezifischen Funktionen und Anwendungsfällen. Welche Art von API-Technologie für Ihre Anwendung am besten geeignet ist, hängt von Ihren speziellen Bedürfnissen und Anforderungen ab. Hier sind sechs gängige Arten von API-Technologien:
- REST-APIs: REST APIs sind eine Art Web-API, die HTTP-Methoden (wie GET, POST, PUT und DELETE) zum Abrufen und Bearbeiten von Daten verwendet. Sie sind leicht und flexibel konzipiert und werden häufig zum Erstellen von Web- und Mobilanwendungen verwendet.
- SOAP-APIs: SOAP (Simple Object Access Protocol) APIs sind Web-API-Typen, die XML (Extensible Markup Language), um Daten zu kodieren und über HTTP zu übertragen. SOAP-APIs sind standardisierter und strukturierter als REST-APIs und werden häufig in Unternehmensumgebungen verwendet, in denen Sicherheit und Zuverlässigkeit wichtig sind.
- GraphQL-APIs: GraphQL ist eine Abfragesprache für APIs, die es Entwicklern ermöglicht, bestimmte Daten von einer API anzufordern, anstatt einen festen Datensatz zu erhalten. GraphQL-APIs sind flexibel und ermöglichen es Entwicklern, nur die benötigten Daten anzufordern, was die Leistung verbessern und Datenverschwendung reduzieren kann.
- Webhooks: Webhooks sind eine Art API-Technologie, die es einem Server ermöglicht, Daten in Echtzeit an einen Client zu senden, anstatt dass der Client Daten vom Server anfordern muss. Sie werden häufig verwendet, um Echtzeitkommunikation zwischen Anwendungen zu ermöglichen und Aktionen auszulösen, wenn bestimmte Ereignisse eintreten.
- Cloud-APIs: Cloud-APIs ermöglichen Entwicklern den Zugriff auf und die Interaktion mit Cloud-Computing-Diensten wie Speicher, Datenbanken und Analysen. Diese APIs können Entwicklern dabei helfen, Anwendungen effizienter und effektiver zu erstellen und bereitzustellen.
- Hardware-APIs: Hardware-APIs ermöglichen Entwicklern den Zugriff auf und die Steuerung von Hardwaregeräten wie Sensoren, Kameras und Druckern. Diese APIs können Anwendungen erstellen, die mit physischen Geräten interagieren und diese steuern.
Wenn Sie sich mit einer Anwendung mit einer schlecht unterstützten oder dokumentierten API anmelden, treiben Sie Ihr Entwicklungsteam in den Wahnsinn und Ihre Integrationen werden wahrscheinlich nicht den gewünschten Erfolg haben oder ganz fehlschlagen. Finden Sie den richtigen Anbieter, und Ihre Integration wird funktionieren, und Ihre Entwicklungsleute werden Ihnen gerne behilflich sein!
Forschungsfragen zu ihren API-Funktionen:
Um die Integrationsmöglichkeiten einer Plattform über eine API zu untersuchen, ist mehr als nur eine einfache Frage erforderlich: Gibt es eine API? Es gibt Folgefragen! Hier ist eine umfassende Liste mit Fragen, die Sie einem Unternehmen zu seinen APIs stellen können. Sie deckt verschiedene wichtige Aspekte wie Versionierung, Einhaltung gesetzlicher Vorschriften, Sicherheit, Verfügbarkeit und mehr ab:
Gesamtübersicht
- Was ist der Hauptzweck Ihrer API und wie passt sie zur Gesamtstrategie Ihres Unternehmens?
- Welche API-Typen bieten Sie an (REST, SOAP, GraphQL usw.)?
- Bietet Ihre API einzigartige Funktionen, die die Konkurrenz nicht bietet?
Feature-Gap-Analyse
- Auf welche in Ihrer Benutzeroberfläche verfügbaren Funktionen kann über die API zugegriffen werden?
- Gibt es exklusive Funktionen der API, die nicht in der Benutzeroberfläche vorhanden sind, oder umgekehrt?
- Wie oft veröffentlichen Sie neue Funktionen, und werden diese gleichzeitig für die Benutzeroberfläche und die API veröffentlicht?
Versionierung und Updates
- Wie handhaben Sie die Versionierung für Ihre API?
- Wie werden Kunden über veraltete Funktionen oder wesentliche Änderungen der API-Versionen benachrichtigt?
- Gibt es abwärtskompatible Updates oder erfordern neue Versionen Codeänderungen auf der Clientseite?
- Unterstützen Sie mehrere Versionen gleichzeitig? Wenn ja, wie lange?
Skalierbarkeit und Leistung
- Wie viele API-Aufrufe werden täglich an Ihre Server getätigt?
- Gibt es einen dedizierten Serverpool für die API oder teilt sie Ressourcen mit anderen Diensten?
- Wie gehen Sie mit der Skalierung bei steigender Nachfrage um? Haben Sie Vorkehrungen für plötzliche Verkehrsspitzen getroffen?
Dokumentation und Support
- Können wir auf die API-Dokumentation zugreifen? Wie häufig wird sie aktualisiert?
- Bietet die Dokumentation detaillierte Erklärungen zu allen Funktionen und Variablen?
- Gibt es Codebeispiele, SDKs, oder Bibliotheken für verschiedene Sprachen und Frameworks?
- Welche Supportkanäle stehen für API-Probleme zur Verfügung? (z. B. Live-Chat, E-Mail, dedizierter Account-Manager)
Entwickler-Community und Ressourcen
- Verfügen Sie über eine Online-Entwickler-Community zum Austausch von Code, Best Practices und Integrationserfahrungen?
- Gibt es Entwicklerforen, FAQ, oder Wissensdatenbanken speziell für API-Benutzer?
- Stehen Ihren Kunden dedizierte Integrationsressourcen oder interne Berater zur Verfügung?
- Können Sie Referenzen oder Kontaktdaten von Unternehmen angeben, die erfolgreich in Ihre API integriert wurden?
Integrationskompatibilität
- Welche Datenformate unterstützt die API (z. B. JSON, XML, usw.)?
- Welche Plattformen, Anwendungen und Programmiersprachen wurden erfolgreich in Ihre API integriert?
- Gibt es bereits Produktintegrationen mit Drittanbietern (3P) Werkzeuge?
- Bieten Sie eine Bibliothek mit Codebeispielen an, um die Integrationsbemühungen zu beschleunigen?
- Können wir zum Testen auf eine Sandbox oder eine Nicht-Produktionsumgebung zugreifen?
Einschränkungen und Ratenbegrenzungen
- Welche API-Ratenbegrenzungen gibt es (z. B. Aufrufe pro Sekunde, Minute, Stunde)?
- Gibt es je nach Art der abgerufenen Daten unterschiedliche Ratenbegrenzungen?
- Sind Preisbegrenzungen auf der Grundlage von Nutzungsniveaus oder Abonnementplänen verhandelbar?
Sicherheit und Compliance
- Wie authentifiziert Ihre API Benutzer? (z. B. API-Schlüssel, OAuth, tokenbasiert usw.)
- Gibt es Möglichkeiten, den API-Zugriff einzuschränken, indem IP-Adresse oder Standort?
- Welche Verschlüsselungsstandards befolgen Sie für übertragene und gespeicherte Daten?
- Gibt es bestimmte behördliche Zertifizierungen, an die sich die API hält, wie etwa Datenschutz, HIPAA oder PCI-DSS?
- Welche Datenschutzmaßnahmen werden getroffen, um die Einhaltung internationaler Vorschriften zu gewährleisten?
10 Zuverlässigkeit und Betriebszeit
- Wie hoch ist die durchschnittliche Betriebszeit Ihrer API?
- Stellen Sie ein öffentliches Uptime-Dashboard zur Verfügung?
- Wie hoch ist die Fehlerquote und wie wird sie erfasst?
- Gibt es bei Ihnen bestimmte Wartungszeiten und wie werden die Kunden benachrichtigt?
- Gibt es automatische Wiederholungsmechanismen im Falle einer Ausfallzeit oder eines Ausfalls?
Service Level Agreements (SLA)
- Bieten Sie ein SLA für Ihre API an und wie hoch ist die garantierte Betriebszeit?
- Wie hoch ist Ihre typische Reaktionszeit bei API-Problemen, wie im SLA beschrieben?
- Gibt es bei Verstößen gegen das SLA finanzielle Gutschriften oder Servicegutschriften?
Zukünftige Roadmap
- Können Sie einen Fahrplan für kommende Funktionen und Updates der API mit uns teilen?
- Wie häufig werden neue Versionen oder wichtige Updates veröffentlicht?
- Beziehen Sie Kunden in Betatests oder Feedback-Sitzungen zu neuen Funktionen ein?
Überwachung und Protokollierung
- Stellen Sie Protokollierungs- oder Überwachungstools für die API-Aktivität bereit?
- Können Kunden auf Nutzungsstatistiken zugreifen, um Anrufvolumen, Fehlerraten und Leistung zu verfolgen?
- Gibt es integrierte Tools zum Verfolgen der Benutzeraktivität und Erkennen von Anomalien?
Abrechnungs- und Preisstruktur
- Wie ist das Preismodell für den API-Zugriff (z. B. Bezahlung pro Anruf, gestaffeltes Abonnement)?
- Fallen für höhere Nutzungsgrade oder Premiumfunktionen zusätzliche Gebühren an?
- Können die Preise je nach Volumen oder bestimmten Anwendungsfällen angepasst werden?
Integrations- und Onboardingprozess
- Wie sieht der typische Onboardingprozess für neue API-Benutzer aus?
- Bieten Sie Beratungsdienste zur Unterstützung bei der Ersteinrichtung und Integration an?
- Wie lange dauert eine Integration normalerweise und welche Ressourcen werden benötigt?
Mithilfe dieser Fragen erhalten Sie einen umfassenden Einblick in die API eines Unternehmens, einschließlich ihrer Funktionen, Einschränkungen und Supportstruktur. Dieser Ansatz ist entscheidend für die Auswahl einer API, die Ihren Anforderungen entspricht, zukünftiges Wachstum unterstützt und die für geschäftskritische Anwendungen erforderliche Zuverlässigkeit und Sicherheit bietet.
Der Schlüssel zu diesen Fragen ist, dass die Integration Sie mit der Plattform „verheiratet“. Sie möchten doch niemanden heiraten, ohne so viel wie möglich über ihn zu erfahren, oder? Das passiert, wenn Leute eine Plattform kaufen, ohne ihre Integrationsmöglichkeiten zu kennen.
Neben einer API sollten Sie auch versuchen, herauszufinden, welche anderen Integrationsressourcen sie möglicherweise haben: Barcoding, Mapping, Datenbereinigungsdienste, RSS, Webformulare, Widgets, formelle Partnerintegrationen, Skript-Engines, SFTP Tropfen usw.
Weitere Artikeln Martech Zone Inhalt
