Softwareentwicklung & PHP

Externe API in bestehende PHP-Anwendung integrieren

Externe API an eine bestehende PHP-Anwendung anbinden: Erfahren Sie, wie Sie vorhandenen Code prüfen, Daten sicher übertragen und einen Relaunch vermeiden.

3D-Illustration einer bestehenden PHP-Anwendung mit externer API-Anbindung, Datenbank und kontrollierter Testumgebung

Ein Unternehmen nutzt seit mehreren Jahren eine individuell entwickelte PHP-Anwendung. Die Software verwaltet Kunden, Bestellungen oder interne Arbeitsabläufe und funktioniert im Alltag zuverlässig. Nun soll ein externer Dienst angebunden werden, damit bestimmte Informationen automatisch ausgetauscht werden können. Doch der ursprüngliche Entwickler ist möglicherweise nicht mehr verfügbar und die technische Dokumentation ist unvollständig. Eine externe API lässt sich unter geeigneten Voraussetzungen auch in eine bestehende PHP-Anwendung integrieren. Dafür muss nicht automatisch die gesamte Software neu entwickelt werden.

1. Warum benötigen bestehende PHP-Anwendungen neue Schnittstellen?

Viele Unternehmen verwenden individuelle Software, die über Jahre an ihre Arbeitsabläufe angepasst wurde.

Solche Anwendungen können Bestellungen verwalten, Kundeninformationen bereitstellen oder Daten für interne Abteilungen aufbereiten.

Mit der Zeit entstehen neue Anforderungen.

Beispielsweise soll eine vorhandene PHP-Anwendung:

  • Bestellinformationen an einen externen Dienst übertragen,
  • den Bearbeitungsstatus aus einem anderen System abrufen,
  • Kundendaten mit einer vorhandenen CRM-Lösung austauschen,
  • Informationen aus einer externen Produktdatenbank übernehmen,
  • eine neue Funktion eines Drittanbieters bereitstellen.

Die bestehende Software erfüllt dabei möglicherweise weiterhin ihren ursprünglichen Zweck.

Ein vollständiger Neubau wäre deshalb nicht automatisch wirtschaftlich sinnvoll.

Wann genügt eine gezielte Erweiterung?

Eine gezielte API-Integration kann sinnvoll sein, wenn die Anwendung technisch zugänglich ist und die neue Funktion ausreichend vom vorhandenen Code abgegrenzt werden kann.

Wichtig ist außerdem, dass die bestehende Architektur eine Erweiterung erlaubt, ohne wichtige Funktionen unnötig zu gefährden.

Fehlen diese Voraussetzungen, können zunächst begrenzte Anpassungen am Code notwendig sein.

2. Welche Voraussetzungen müssen vor der Integration geprüft werden?

Der erste Schritt sollte nicht darin bestehen, sofort API-Zugangsdaten in den vorhandenen PHP-Code einzubauen.

Zunächst müssen die beteiligten Systeme und der gewünschte Datenfluss verstanden werden.

Wichtige Prüfpunkte vor einer API-Integration
Bereich Was geprüft wird
Bestehender PHP-Code Wo die neue Funktion sinnvoll eingebunden werden kann
PHP-Version Ob Laufzeit und benötigte Bibliotheken kompatibel sind
Externe API Welche Funktionen tatsächlich angeboten werden
Authentifizierung Welche Zugriffsverfahren und Berechtigungen erforderlich sind
Datenstruktur Wie Felder und Datensätze eindeutig zugeordnet werden
Geschäftsprozess Wann Daten übertragen werden sollen und was danach geschieht
Fehlerbehandlung Wie Ausfälle, Zeitüberschreitungen und Wiederholungen behandelt werden
Testumgebung Wie die Integration ohne unerwünschte Produktivaktionen geprüft werden kann

Was ist bei älterem PHP-Code besonders wichtig?

Eine ältere Anwendung kann individuelle Bibliotheken, spezielle Datenbankstrukturen oder nicht dokumentierte Abhängigkeiten enthalten.

Diese müssen nicht grundsätzlich gegen eine Erweiterung sprechen.

Sie können jedoch beeinflussen, wie die neue API angebunden werden sollte.

Eine gute technische Analyse prüft deshalb zunächst den relevanten Programmteil, statt ohne konkreten Anlass die gesamte Anwendung umzubauen.

3. Praxisbeispiel: Eine PHP-Auftragsverwaltung soll eine Versand-API nutzen

Angenommen, ein mittelständischer Händler verwendet eine individuell entwickelte PHP-Anwendung zur Verwaltung von Bestellungen.

Nach der Bearbeitung eines Auftrags überträgt ein Mitarbeiter die Versandinformationen bisher manuell an einen externen Versanddienst.

Nun soll die vorhandene Anwendung eine API nutzen, damit die benötigten Daten direkt übertragen werden können.

Welche Funktion soll ergänzt werden?

Die bestehende Auftragsverwaltung bleibt erhalten.

Ergänzt wird ein definierter Arbeitsschritt:

  1. Auftrag freigeben: Ein berechtigter Mitarbeiter bestätigt, dass ein Auftrag für den Versand vorbereitet ist.
  2. Daten prüfen: Die Anwendung kontrolliert die notwendigen Versandinformationen.
  3. API aufrufen: Die bestätigten Daten werden an den externen Dienst übertragen.
  4. Antwort verarbeiten: Die Anwendung übernimmt die tatsächlich zurückgegebenen Informationen.
  5. Status dokumentieren: Erfolgreiche und fehlgeschlagene Übertragungen bleiben nachvollziehbar.

Welche dieser Funktionen verfügbar sind, hängt von der konkreten Versand-API ab.

Was passiert, wenn die API nicht erreichbar ist?

Die Anwendung sollte nicht einfach behaupten, dass die Übertragung erfolgreich war.

Stattdessen muss der fehlgeschlagene Vorgang erkennbar bleiben.

Je nach Geschäftsprozess kann eine spätere Wiederholung sinnvoll sein.

Dabei muss verhindert werden, dass versehentlich zwei identische Versandaufträge erzeugt werden.

Das Beispiel ist fiktiv und beschreibt keinen konkreten Kundenauftrag von Kubertino.

4. Welche technischen Probleme müssen bei der API-Anbindung berücksichtigt werden?

Eine Verbindung zu einer externen API besteht nicht nur aus dem Senden und Empfangen von Daten.

Für den laufenden Betrieb sind mehrere technische Punkte wichtig.

Zugangsdaten und Berechtigungen

API-Schlüssel und andere Zugangsdaten dürfen nicht ungeschützt in öffentlich zugänglichen Dateien oder Protokollen gespeichert werden.

Die Verbindung sollte nur die tatsächlich benötigten Berechtigungen erhalten.

Ungültige oder unvollständige Daten

Eine externe API kann bestimmte Pflichtfelder oder Datenformate verlangen.

Deshalb sollten Informationen vor der Übertragung geprüft werden.

Auch zurückgelieferte Daten dürfen nicht ungeprüft in die vorhandene Datenbank übernommen werden.

Zeitüberschreitungen und externe Ausfälle

Ein externer Dienst kann vorübergehend langsam oder nicht erreichbar sein.

Die PHP-Anwendung benötigt deshalb passende Zeitlimits und eine definierte Fehlerbehandlung.

Bei bestimmten Geschäftsprozessen kann eine Hintergrundverarbeitung sinnvoller sein als ein API-Aufruf während einer Benutzeranfrage.

Wiederholungen ohne doppelte Aktionen

Besonders wichtig sind Vorgänge, bei denen eine erneute Übertragung unbeabsichtigt zusätzliche Datensätze oder Aufträge erzeugen könnte.

Wenn die externe API eine geeignete Idempotenzfunktion unterstützt, sollte deren Nutzung geprüft werden.

Andernfalls können andere Verfahren zur eindeutigen Identifikation und Kontrolle von Vorgängen notwendig sein.

Technische Umsetzung in PHP

PHP bietet verschiedene Möglichkeiten, mit externen HTTP-Diensten zu kommunizieren.

Eine verbreitete Grundlage ist die cURL-Erweiterung.

Die offizielle PHP-Dokumentation zu cURL beschreibt die entsprechenden Funktionen.

Welche Bibliothek für eine konkrete Integration geeignet ist, hängt von der bestehenden Anwendung und den Anforderungen der API ab.

5. Wie wird eine bestehende PHP-Anwendung sicher erweitert?

Eine API-Integration sollte als klar abgegrenzte Änderung geplant werden.

So lässt sich besser erkennen, welche Teile der vorhandenen Anwendung betroffen sind.

  1. Aufgabe beschreiben: Festlegen, welche Informationen zwischen welchen Systemen ausgetauscht werden sollen.
  2. Bestehenden Code untersuchen: Relevante Funktionen, Datenbankzugriffe und technische Abhängigkeiten prüfen.
  3. API-Dokumentation auswerten: Verfügbare Endpunkte, Zugriffsrechte und technische Einschränkungen klären.
  4. Datenzuordnung festlegen: Definieren, welche internen Felder welchen externen Informationen entsprechen.
  5. Integration entwickeln: Die neue Funktion möglichst nachvollziehbar in die vorhandene Architektur einbinden.
  6. Fehlerfälle testen: Ungültige Daten, unterbrochene Verbindungen und wiederholte Übertragungen prüfen.
  7. Bestehende Funktionen kontrollieren: Sicherstellen, dass die vereinbarten bisherigen Abläufe weiterhin funktionieren.
  8. Produktive Änderung abstimmen: Die neue Funktion kontrolliert aktivieren und die ersten Übertragungen überwachen.

Muss dafür die Datenbank geändert werden?

Nicht zwangsläufig.

Wenn die notwendigen Informationen bereits vorhanden sind, kann eine Integration unter Umständen ohne größere Änderungen am Datenmodell umgesetzt werden.

In anderen Fällen werden zusätzliche Felder oder Tabellen benötigt, beispielsweise für externe Vorgangskennungen oder Übertragungsstatus.

Solche Änderungen sollten auf den tatsächlichen Bedarf begrenzt und vor der produktiven Einführung getestet werden.

6. Was kostet die Integration einer externen API in eine bestehende PHP-Anwendung?

Der Aufwand hängt nicht allein von der Anzahl der API-Endpunkte ab.

Entscheidend sind die Qualität des vorhandenen Codes, die verfügbaren Integrationsmöglichkeiten und die gewünschten Geschäftsregeln.

Eine einfache Datenabfrage kann weniger Aufwand erfordern als eine bidirektionale Synchronisierung mit mehreren Fehler- und Freigabezuständen.

Technische Analyse bei unklarem Aufwand

Wenn die vorhandene Anwendung zunächst untersucht werden muss, bietet Kubertino eine technische Analyse für 490 € netto an.

Sie umfasst eine vereinbarte Fragestellung in einem System und insgesamt bis zu 2,5 Stunden für Zugangseinrichtung, Untersuchung und Dokumentation.

Das Ergebnis dient dazu, technische Voraussetzungen, offene Punkte und mögliche nächste Schritte zu klären.

Direkte PHP-Entwicklung

Für PHP-Entwicklung berechnet Kubertino 190 € netto pro Stunde.

Beim ersten direkten Umsetzungsauftrag gilt ein Mindestumfang von vier Stunden, entsprechend 760 € netto.

Nach einer zuvor durchgeführten technischen Analyse wird eine anschließende Umsetzung separat vereinbart; dafür gilt kein erneuter Mindestumfang von vier Stunden.

Alle Preise verstehen sich zuzüglich gesetzlicher Umsatzsteuer.

Vor Beginn werden der vereinbarte Leistungsumfang und ein Kostenlimit festgelegt.

Die aktuellen Konditionen finden Sie auf unserer Leistungsseite PHP-Entwicklung.

7. Externe API mit Kubertino in eine PHP-Anwendung integrieren

Kubertino unterstützt Unternehmen bei der Weiterentwicklung bestehender PHP-Websites, Onlineshops und individueller Anwendungen.

Das kann auch die Anbindung eines externen Dienstes über eine vorhandene API umfassen.

Im Mittelpunkt steht zunächst die konkrete Aufgabe.

Eine bestehende Anwendung muss nicht ohne technischen Grund vollständig ersetzt werden.

Welche Informationen benötigen wir für eine erste Einschätzung?

  • Welche PHP-Anwendung soll erweitert werden?
  • Welcher externe Dienst soll angebunden werden?
  • Gibt es eine API-Dokumentation?
  • Welche Informationen sollen übertragen werden?
  • In welche Richtung soll der Datenaustausch erfolgen?
  • Welche bestehenden Funktionen dürfen nicht beeinträchtigt werden?
  • Ist der ursprüngliche PHP-Entwickler noch verfügbar?

Technische Zugangsdaten werden anschließend separat über einen geeigneten sicheren Weg abgestimmt.

Unsere Leistung PHP-Entwicklung für bestehende Anwendungen richtet sich an Unternehmen, die eine konkrete Funktion ergänzen, einen Fehler beheben oder vorhandenen Code weiterentwickeln möchten.

Für einen allgemeinen Überblick zu unterschiedlichen Integrationsmöglichkeiten empfehlen wir außerdem den Beitrag Software-Schnittstellen und API-Integration.

Wenn der bisherige Entwickler nicht mehr erreichbar ist, erläutert unser Beitrag PHP-Betreuung ohne eigenen Entwickler die Möglichkeiten einer externen Weiterentwicklung.

Für eine erste Anfrage genügt die Beschreibung der bestehenden Anwendung und der gewünschten API-Verbindung.

Auf dieser Grundlage lässt sich klären, ob eine direkte Umsetzung möglich ist oder zunächst eine begrenzte technische Analyse sinnvoll wäre.

8. Häufige Fragen zur API-Integration in PHP

Kann man eine externe API in eine alte PHP-Anwendung integrieren?

Grundsätzlich ja. Entscheidend ist, ob die vorhandene Anwendung technisch zugänglich ist und die neue Schnittstelle mit ihrer Architektur vereinbar ist. Bei älterem Code können zunächst gezielte Anpassungen notwendig sein.

Muss eine PHP-Anwendung für eine neue Schnittstelle neu entwickelt werden?

Nicht automatisch. Häufig lässt sich die gewünschte Funktion ergänzen. Ob größere Änderungen erforderlich sind, sollte erst nach einer Untersuchung des bestehenden Codes entschieden werden.

Welche Arten von APIs kann PHP verwenden?

PHP kann unter anderem mit HTTP-basierten APIs kommunizieren, beispielsweise mit REST-Schnittstellen. Die konkrete Umsetzung hängt von der API-Dokumentation, der Authentifizierung und den verwendeten Datenformaten ab.

Was passiert, wenn die externe API ausfällt?

Die Integration sollte Fehler und Zeitüberschreitungen kontrolliert behandeln. Je nach Geschäftsprozess können Protokollierung, spätere Wiederholungen oder eine manuelle Prüfung erforderlich sein. Doppelte Aktionen müssen dabei vermieden werden.

Kann eine externe Agentur den vorhandenen PHP-Code erweitern?

Ja. Erfahrene PHP-Entwickler können auch Anwendungen untersuchen und erweitern, die von anderen Entwicklern erstellt wurden. Voraussetzung sind geeignete Zugänge, verfügbarer Quellcode und eine ausreichend klar beschriebene Aufgabe.

Was kostet eine PHP-API-Integration bei Kubertino?

PHP-Entwicklung kostet bei Kubertino 190 € netto pro Stunde. Beim ersten direkten Umsetzungsauftrag gilt ein Mindestumfang von vier Stunden. Bei unklarem Aufwand kann zunächst eine technische Analyse für 490 € netto vereinbart werden. Der Gesamtaufwand hängt von den beteiligten Systemen und den benötigten Funktionen ab.

Nächster Schritt

Möchten Sie prüfen, was davon für Ihr Unternehmen relevant ist?

Wir prüfen Website, Inhalte, Anfragewege und mögliche Automatisierungspunkte und geben eine klare erste Einschätzung.

KI-Potenzial prüfen Gespräch buchen