REST-APIs

Eine Schnittstelle, mit der andere arbeiten können

Für Apps, eigene Frontends, Partner und andere Systeme. Mit Anmeldung, Rechten, Versionierung und einer Dokumentation, die ein fremdes Team ohne Rückfragen nutzen kann.

Laravel seit 2020 Dokumentation ab Tag eins Testzugang zum Entwickeln
Was im Lieferumfang ist

Gebaut für die, die sie benutzen

Eine Schnittstelle wird selten von denen benutzt, die sie bauen. Am anderen Ende sitzt ein App-Team, eine Partnerfirma oder ein anderes System, und für die zählt vor allem, ob sie ohne Rückfragen damit arbeiten können. Deshalb entstehen hier Entwurf und Dokumentation zuerst: Welche Zugriffe gibt es, welche Daten liefern sie, wie sieht eine Antwort aus, was passiert im Fehlerfall. Erst wenn dieser Entwurf besprochen ist, beginnt die Umsetzung. Das klingt umständlich und spart in der Praxis die meiste Zeit, weil Missverständnisse auf dem Papier billiger sind als im Code.

Bei der Anmeldung hängt der richtige Weg daran, wer zugreift. Für eigene Anwendungen genügen meist Zugangstoken, wie Laravel sie mitbringt. Greift eine fremde Anwendung im Namen eines Nutzers zu, kommt das übliche Verfahren mit ausdrücklicher Zustimmung und begrenzter Gültigkeit zum Einsatz. Partner, die nur Daten abholen, bekommen einen eigenen Zugang mit klar begrenzten Rechten. In allen Fällen gehören Rechte, eine Begrenzung der Zugriffe pro Zeitraum und ein Protokoll dazu, damit im Zweifel nachvollziehbar ist, wer wann was abgerufen hat.

Der Teil, der später über Ärger oder Ruhe entscheidet, ist der Umgang mit Änderungen. Sobald andere die Schnittstelle nutzen, darf sie sich nicht unangekündigt ändern: Ein umbenanntes Feld legt eine App lahm, die im App Store liegt und nicht mal eben aktualisiert wird. Deshalb wird von Anfang an versioniert, Ergänzungen laufen zusätzlich statt ersetzend, und Abkündigungen bekommen eine Frist. Wie damit umgegangen wird, steht in der Dokumentation, bevor der erste fremde Zugriff kommt.

Zum Lieferumfang gehören automatisierte Tests für die Endpunkte. Bei einer Schnittstelle sind sie mehr wert als anderswo, weil niemand von Hand durchklicken kann, was eine Maschine benutzt: Ein Test zeigt in Sekunden, ob nach einem Update noch dieselbe Antwort herauskommt. Dazu kommen eine Testumgebung mit Beispieldaten, gegen die das andere Team entwickeln kann, bevor es live geht, und die Dokumentation mit Beispielanfragen und Beispielantworten.

Nicht jede Aufgabe braucht übrigens eine eigene Schnittstelle. Sollen zwei bestehende Systeme Daten austauschen, ist oft ein vermittelndes System der bessere Weg, und wo eine Oberfläche und ihr Backend ohnehin zusammengehören, spart der TALL-Stack die Schnittstelle ganz. Was im konkreten Fall passt, wird im Erstgespräch geklärt.

Die Zusammenarbeit läuft standardmäßig zu 100 % remote und damit ortsunabhängig, direkt mit Auftraggebern, als Verstärkung für Agenturen und über IT-Vermittler. Code geht über Git, die Testumgebung steht dem anderen Team zur Verfügung, die Abstimmung läuft über Mail, Slack, Teams oder kurze Video-Calls. Werden dabei echte Personendaten verarbeitet, gehört ein Auftragsverarbeitungsvertrag nach Art. 28 DSGVO zum Auftrag. Gearbeitet wird aus dem eigenen Büro im kontorworx-Coworking-Space in Rheine, persönliche Termine vor Ort sind nach Absprache möglich.

Aktuelle Verfügbarkeit · Eingeschränkt

Freie Kapazität ab 01.09.2026

25% für neue Projekte

Antwort innerhalb von 2-5 Werktagen je nach Projektgröße.

Anwendungsfälle

Wann lohnt sich eine eigene Schnittstelle?

Eine App braucht ein Backend

Die mobile App ist geplant oder existiert, es fehlt die Gegenstelle: Anmeldung, Daten, Rechte, Benachrichtigungen. Genau das leistet eine Schnittstelle, die von mehreren Anwendungen gleichzeitig genutzt werden kann.

Frontend und Backend werden getrennt

Ein eigenes Frontend-Team arbeitet mit einem anderen Werkzeugkasten. Über eine dokumentierte Schnittstelle können beide Seiten unabhängig voneinander weiterentwickeln, ohne sich gegenseitig zu blockieren.

Partner sollen Daten abrufen

Händler, Lieferanten oder Dienstleister wollen Bestände, Preise oder Aufträge automatisch abrufen statt per Tabelle. Eine Schnittstelle mit eigenen Zugängen je Partner ersetzt den Mailverkehr.

Zwei Systeme sollen miteinander sprechen

Shop und Warenwirtschaft, Portal und Fachanwendung: Wo Daten regelmäßig zwischen Systemen wandern, braucht es eine saubere Übergabestelle statt Export-Dateien auf einem Netzlaufwerk.

Die vorhandene Schnittstelle ist gewachsen

Über die Jahre sind Endpunkte dazugekommen, die sich unterschiedlich verhalten, unterschiedlich anmelden und unterschiedlich Fehler melden. Eine Bestandsaufnahme zeigt, was sich vereinheitlichen lässt, ohne bestehende Nutzer zu brechen.

Die Schnittstelle ist Teil des Produkts

Kunden erwarten, die eigene Software anbinden zu können. Dann ist die Schnittstelle kein Nebenprodukt, sondern ein Merkmal, das dokumentiert, versioniert und verlässlich sein muss.

Automatisierung soll andocken

Abläufe sollen über Automatisierungs-Werkzeuge angestoßen werden oder Ereignisse aus dem System sollen andere Werkzeuge auslösen. Dafür braucht es abrufbare Daten und Meldungen nach außen.

Alte Daten sollen nutzbar werden

In einem gewachsenen System stecken Daten, die anderswo gebraucht werden. Eine Schnittstelle davor macht sie zugänglich, ohne dass das Altsystem angefasst werden muss.

Vorgehen

Wie die Schnittstelle entsteht

Entwurf und Dokumentation stehen bewusst vorn, weil sich Missverständnisse dort am günstigsten klären lassen. Wie viele Endpunkte folgen, ergibt sich aus dem Entwurf. Vertragsbasis ist ein Dienstvertrag mit Abrechnung nach Aufwand, vorab gibt es eine ehrliche Aufwandsschätzung.

  1. 1

    1. Anforderungen und Entwurf

    Wer nutzt die Schnittstelle, welche Daten werden gebraucht und in welcher Form, wie wird angemeldet. Daraus entsteht ein Entwurf der Endpunkte samt Beispielantworten, der besprochen wird, bevor eine Zeile Code entsteht.

  2. 2

    2. Grundgerüst und Anmeldung

    Aufbau der Schnittstelle mit Anmeldung, Rechten und Begrenzung der Zugriffe. Dazu die Struktur der Antworten und ein einheitlicher Umgang mit Fehlern, damit sich die Schnittstelle überall gleich verhält.

  3. 3

    3. Endpunkte umsetzen

    Die einzelnen Zugriffe entstehen nacheinander, jeweils mit Prüfung der Eingaben, Rechten und automatisierten Tests. So lässt sich früh gegen die Schnittstelle entwickeln, während weitere Endpunkte dazukommen.

  4. 4

    4. Dokumentation und Testzugang

    Eine Dokumentation, mit der ein fremdes Team ohne Rückfragen arbeiten kann, dazu eine Testumgebung mit Beispieldaten. Beides entsteht mit der Schnittstelle, nicht danach.

  5. 5

    5. Übergabe und Betrieb

    Einrichtung der Live-Umgebung, Protokollierung und Überwachung, Übergabe des Git-Repositorys. Für spätere Erweiterungen wird festgelegt, wie Änderungen eingeführt werden, ohne bestehende Nutzer zu brechen.

FAQ

Fragen zu REST-APIs

Was kostet die Entwicklung einer REST-API?

Die Entwicklung läuft nach Aufwand auf Tagessatzbasis (die Tagessätze stehen offen auf der Laravel-Seite). Den Aufwand bestimmen die Zahl der Endpunkte, die Komplexität der Rechte und die Frage, ob die Daten schon sauber vorliegen oder erst aufbereitet werden müssen. Nach dem Entwurf der Endpunkte steht eine belastbare Schätzung.

Wie wird die Anmeldung gelöst?

Für Anwendungen im eigenen Haus reichen meist einfache Zugangstoken, wie Laravel sie von Haus aus mitbringt. Für fremde Anwendungen, die im Namen eines Nutzers zugreifen, kommt das übliche Verfahren mit Zustimmung und begrenzter Gültigkeit zum Einsatz. Für Partner, die nur Daten abholen, genügt oft ein fester Zugang je Partner mit klar begrenzten Rechten. Was passt, entscheidet sich danach, wer zugreift und wie sensibel die Daten sind.

Wie werden spätere Änderungen behandelt?

Sobald eine Schnittstelle von anderen genutzt wird, darf sie sich nicht unangekündigt ändern. Üblich ist eine Versionierung, sodass bestehende Nutzer auf der alten Fassung bleiben, während neue Möglichkeiten in einer neuen entstehen. Ergänzungen wie zusätzliche Felder sind unkritisch, Umbenennungen und Entfernungen dagegen nicht. Wie damit umgegangen wird, wird vor dem Start festgelegt.

Gehört die Dokumentation dazu?

Ja, und zwar von Anfang an. Eine Schnittstelle ohne Dokumentation ist für ein fremdes Team praktisch unbenutzbar, egal wie sauber sie gebaut ist. Geliefert wird eine Beschreibung aller Endpunkte mit Beispielanfragen und Beispielantworten, dazu eine Testumgebung mit Beispieldaten, gegen die entwickelt werden kann.

Wie wird die Schnittstelle vor Missbrauch geschützt?

Über mehrere Ebenen: Anmeldung und Rechte je Zugang, Begrenzung der Zugriffe pro Zeitraum, Prüfung aller Eingaben und Protokollierung der Aufrufe. Bei sensiblen Daten kommt eine Beschränkung auf bekannte Adressbereiche dazu. Wichtig ist außerdem, dass Fehlermeldungen hilfreich bleiben, ohne interne Details preiszugeben.

Wie schnell ist die Schnittstelle?

Das hängt an den Daten dahinter, nicht an der Schnittstelle selbst. Üblich sind Seitenweise Auslieferung großer Listen, Zwischenspeicher für Daten, die sich selten ändern, und die Verlagerung aufwendiger Arbeiten in den Hintergrund. Wo es eng wird, zeigt eine Messung mit einem Profiler, welche Abfrage die Zeit kostet; mehr dazu unter API-Integration.

Wer betreut die Schnittstelle später?

Schnittstellen sind kein Projekt mit Enddatum: Laravel bekommt Updates, Anforderungen wachsen, neue Nutzer kommen dazu. Auf Wunsch läuft die laufende Laravel-Betreuung mit, alternativ übernimmt das interne Team. Dokumentation und automatisierte Tests sind darauf ausgelegt.

Was passiert, wenn du ausfällst oder später nicht verfügbar bist?

Der vollständige Quelltext liegt im Git-Repository des Auftraggebers, dazu kommen die Dokumentation der Endpunkte und automatisierte Tests, die zeigen, wie sich die Schnittstelle verhalten soll. Gearbeitet wird mit Laravel-Standardmitteln statt mit Sonderwegen. Alle Zugänge zu Hosting, Git und Anwendung gehören dem Auftraggeber, hier gibt es nur die Berechtigung mitzuarbeiten.
Verwandte Leistungen

Auch interessant

Laravel

Middleware: Systeme verbinden

Mehr erfahren

Laravel

Laravel SaaS-Plattformen

Mehr erfahren

Laravel

Admin-Panel für Laravel

Mehr erfahren

Tagessätze und Wartungspakete stehen offen.

Für Laravel REST-APIs gilt derselbe Satz wie für jede andere Aufgabe: 760 bis 1.080 € pro Tag netto (95 bis 135 € pro Stunde), je nach Laufzeit und Dringlichkeit, Wartungspakete ab 349 € pro Monat. Alle Stufen im Detail auf der Laravel-Seite. Was eine konkrete Aufgabe kostet, ergibt sich aus der Aufwandsschätzung nach dem Erstgespräch.

Wer soll die Schnittstelle nutzen?

Eine kurze Beschreibung genügt: welche Daten, für welche Anwendung, für wen. Antwort mit erster Einschätzung innerhalb von 2-5 Werktagen.

Tagessätze 760-1.080 € netto · Antwort in 2-5 Werktagen · Direktkontakt