INTERNET WORLD Business





Eigene und externe APIs in den Griff bekommen

Techniktipp

Marcel Semmler, Marketing Manager der Allyve GmbH & Co. KG, Hamburg

www.allyve.com

Die Kommunikation zwischen den eigenen IT-Systemen und denen von Dienstleistern oder Kunden ist mittlerweile oft unerlässlich geworden. Doch eine steigende Zahl an Beteiligten erhöht die Komplexität und birgt gelegentlich Probleme. Sechs Tipps, die das Zusammenspiel erleichtern:

Eine gemeinsame Sprache sprechen

Die komfortabelste Lösung ist, wenn eine für beide Kommunikationspartner neue Schnittstelle geschaffen wird. So können vorab Gemeinsamkeiten herausgestellt, die benötigten Funktionen und der Datenumfang vereinbart sowie die eingesetzten Technologien festgelegt werden.

Schnittstelle und Interna trennen

Eine API und deren Datentypen sollten sich immer an ihrem Einsatzzweck und nicht an der internen Umsetzung orientieren. Strukturieren Sie die Datentypen so, wie Sie sie als Kunde zur Weiterverarbeitung erwarten würden, und nicht so, wie sie technisch in Ihrer Datenbank abgebildet werden.

Bewährtes wiederverwenden

Wenn sich Technologien, Bibliotheken oder andere Komponenten als passend für die eigenen Schnittstellen erwiesen haben, sollten Neuentwicklungen soweit möglich immer auf den im eigenen Haus etablierten Standards aufbauen.

Bei der Sache bleiben

Wenn Sie mehrere APIs für unterschiedliche Zwecke anbieten, sollten Sie immer die gleichen Technologien verwenden. So stellen Sie eine problemlose Integration und Interoperabilität sicher.

An die Leser denken

Erleichtern Sie Ihren Kunden die Einbindung Ihrer API, indem Sie entweder eigene Bibliotheken für die gängigen Programmiersprachen bereitstellen oder Ihre API so entwickeln, dass gängige Client-Bibliotheken wie Scribe eingesetzt werden können.

Gelerntes dokumentieren

Dokumentationen beziehen sich oft leider nicht auf die aktuelle API-Version, sind inhaltlich falsch oder unvollständig. Neu gewonnenes Know-how sollte daher in einem Entwickler-Wiki oder an einer anderen Stelle für eigene Zwecke festgehalten werden.

comments powered by Disqus