15 Fragen, die Sie zu ihrer API stellen sollten, bevor Sie eine Plattform auswählen

Fragen zur API-Auswahl

Ein guter Freund und Mentor hat mir eine Frage gestellt und ich möchte meine Antworten für diesen Beitrag verwenden. Seine Fragen konzentrierten sich etwas mehr auf eine Branche (E-Mail), daher habe ich meine Antworten auf alle APIs verallgemeinert. Er fragte, welche Fragen ein Unternehmen einem Anbieter zu seiner API stellen sollte, bevor er eine Auswahl traf.

Warum benötigen Sie APIs?

An Anwendungsprogrammierschnittstelle (API) ist die Schnittstelle, die ein Computersystem, eine Bibliothek oder eine Anwendung bereitstellt, um zu ermöglichen, dass Dienste von anderen Computerprogrammen angefordert werden, und / oder um den Datenaustausch zwischen ihnen zu ermöglichen.

Wikipedia

So wie Sie eine URL eingeben und eine Antwort auf einer Webseite zurückerhalten, ist eine API eine Methode, mit der Ihre Systeme eine Antwort anfordern und zurückerhalten können, um Daten zwischen ihnen zu synchronisieren. Da Unternehmen versuchen, sich digital zu transformieren, ist die Automatisierung von Aufgaben durch APIs eine hervorragende Möglichkeit, die Effizienz innerhalb des Unternehmens zu verbessern und menschliches Versagen zu reduzieren.

APIs spielen eine zentrale Rolle bei der Automatisierung, insbesondere in Marketinganwendungen. Eine der Herausforderungen beim Einkauf für einen großen Anbieter mit einem umfassenden API ist, dass Entwicklungsressourcen und -kosten normalerweise ein Nachdenken sind. Das Marketing-Team oder CMO kann den Kauf einer Anwendung vorantreiben, und manchmal erhält das Entwicklungsteam nicht viel Input.

Die Untersuchung der Integrationsfunktionen einer Plattform über eine API erfordert mehr als die einfache Frage: Gibt es eine API?

Wenn Sie sich mit einer Anwendung mit einer schlecht unterstützten oder dokumentierten API anmelden, werden Sie Ihr Entwicklungsteam verrückt machen und Ihre Integrationen werden wahrscheinlich zu kurz kommen oder ganz fehlschlagen. Finden Sie den richtigen Anbieter, und Ihre Integration funktioniert und Ihre Entwickler helfen Ihnen gerne weiter!

Forschungsfragen zu ihren API-Funktionen:

  1. Funktionslücke - Identifizieren Sie, welche Funktionen der Benutzeroberfläche über die Anwendungsprogrammierschnittstelle verfügbar sind. Welche Funktionen hat die API, die die Benutzeroberfläche nicht bietet, und umgekehrt?
  2. Zunder - Fragen Sie, wie viele Anrufe bei ihnen getätigt werden API Täglich. Haben sie einen dedizierten Serverpool? Die Menge ist unglaublich wichtig, da Sie feststellen möchten, ob die API ein nachträglicher Gedanke ist oder tatsächlich Teil der Unternehmensstrategie ist.
  3. Dokumentation - Fragen Sie nach der API-Dokumentation. Es sollte robust sein und alle in der API verfügbaren Funktionen und Variablen enthalten.
  4. Community - Fragen Sie, ob eine Online-Entwickler-Community verfügbar ist, um Code und Ideen mit anderen Entwicklern zu teilen. Entwicklergemeinschaften sind der Schlüssel, um Ihre Entwicklungs- und Integrationsbemühungen schnell und effizient zu starten. Anstatt den API-Mitarbeiter im Unternehmen zu nutzen, nutzen Sie auch alle Kunden, die bereits Versuche und Fehler bei der Integration ihrer Lösung hatten.
  5. REST vs. SOAP - Fragen Sie, welche Art von API Sie haben ... In der Regel gibt es REST-APIs und SOAP-APIs (Web Service). Sie können beide entwickeln. Die Integration mit beiden hat Vorteile und Flüche. Sie sollten mit den Funktionen Ihrer Integrationsressourcen (IT) vertraut sein.
  6. Sprachen - Fragen Sie, welche Plattformen und Anwendungen sie erfolgreich integriert haben, und fordern Sie Kontakte an, damit Sie von diesen Kunden erfahren können, wie schwierig die Integration war und wie gut die API ausgeführt wird.
  7. Einschränkungen - Fragen Sie, welche Einschränkungen der Anbieter in Bezug auf die Anzahl der Anrufe pro Stunde, pro Tag, pro Woche usw. hat. Wenn Sie nicht mit einem skalierbaren Anbieter zusammen sind, wird Ihr Wachstum vom Kunden begrenzt.
  8. Muster - Bieten sie eine Bibliothek mit Codebeispielen an, um den Einstieg zu erleichtern? Viele Unternehmen veröffentlichen SDK (Software Development Kits) für verschiedene Sprachen und Frameworks, die Ihren Integrationszeitplan beschleunigen.
  9. Sandkasten - Bieten sie einen nicht produktiven Endpunkt oder eine Sandbox-Umgebung, in der Sie Ihren Code testen können?
  10. Ressourcen - Fragen Sie, ob sie über dedizierte Integrationsressourcen in ihrem Unternehmen verfügen. Steht ihnen eine interne Beratungsgruppe zur Integration zur Verfügung? Wenn ja, werfen Sie einige Stunden in den Vertrag!
  11. Sicherheit - Wie authentifizieren sie sich mit der API? Handelt es sich um Benutzeranmeldeinformationen, Schlüssel oder andere Methoden? Können sie Anfragen nach IP-Adresse einschränken?
  12. Betriebszeit - Fragen Sie, was ihre API Betriebszeit und Fehlerrate sind und wann ihre Wartungsstunden sind. Strategien, um sie zu umgehen, sind ebenfalls wichtig. Haben sie interne Prozesse, die es erneut versuchen werden? API Anrufe für den Fall, dass der Datensatz aufgrund eines anderen Prozesses nicht verfügbar ist? Ist das etwas, das sie in ihrer Lösung entwickelt haben?
  13. SLA - Haben sie eine Service Level Agreement Wo sollten die Betriebszeiten über 99.9% liegen?
  14. Roadmap - Welche zukünftigen Funktionen integrieren sie in ihre API und wie lauten die erwarteten Lieferpläne?
  15. Integrationen - Welche produzierten Integrationen haben sie entwickelt oder haben sich Dritte entwickelt? Manchmal können Unternehmen auf die interne Entwicklung von Funktionen verzichten, wenn bereits eine andere produktive Integration vorhanden ist und unterstützt wird.

Der Schlüssel zu diesen Fragen ist, dass die Integration Sie mit der Plattform „verbindet“. Sie wollen nicht jemanden heiraten, ohne so viel wie möglich über ihn zu erfahren, oder? Dies ist genau das, was passiert, wenn Leute eine Plattform kaufen, ohne ihre Integrationsfähigkeiten zu kennen.

Über eine API hinaus sollten Sie auch versuchen, herauszufinden, über welche anderen Integrationsressourcen sie möglicherweise verfügen: Barcode, Mapping, Datenbereinigungsdienste, RSS, Web Forms, Widgets, formale Partnerintegrationen, Scripting Engines, SFTP-Drops usw.

3 Kommentare

  1. 1
  2. 3

Was denken Sie?

Diese Seite verwendet Akismet, um Spam zu reduzieren. Erfahren Sie, wie Ihre Kommentardaten verarbeitet werden.