Die API-Schlüssel von Fixh IT machen die Software Ihres Reparaturzentrums zu einer offenen Plattform: Unter Unternehmen > API-Schlüssel kann Ihr Unternehmen REST-v1-API-Schlüssel erstellen und widerrufen, die im Header X-API-Key verwendet werden, um Anfragen an den Endpunkt /api/v1/company/... zu authentifizieren. Das ist keine Funktion nur für einzelne Entwickler: Es ist die Brücke zwischen Ihrer Reparaturwerkstatt und dem Rest Ihres Software-Ökosystems, von Ihrer Website über Ihre Buchhaltungssoftware bis zu Ihrem CRM und dem Bot, der Ihre Kunden beantwortet. Aus Sicherheitsgründen wird der vollständige Schlüssel nur einmal auf dem Bildschirm angezeigt, direkt nach der Erstellung: Danach ist er nur noch in maskierter Form sichtbar (der key_prefix), daher muss er sofort kopiert und sicher aufbewahrt werden.
Warum das für ein Reparaturzentrum wichtig ist
Eine Werkstatt für Smartphone- und PC-Reparaturen arbeitet selten mit nur einem Werkzeug: Es gibt das Hauptverwaltungssystem, vielleicht einen Online-Shop für Ersatzteile, einen Chatbot, der Kunden auf WhatsApp oder Telegram antwortet, eine Buchhaltungssoftware für die Rechnungsstellung, ein Marketing-Tool für E-Mail-Kampagnen. Ohne eine echte Integration bleiben all diese Informationen in jedem System isoliert, sodass Mitarbeiter dieselben Daten mehrfach eingeben müssen, mit dem realen Risiko von Übertragungsfehlern und Verzögerungen in der Kundenkommunikation. REST-v1-API-Schlüssel lösen genau dieses Problem: Sie ermöglichen es einem externen System, automatisch mit den Reparaturdaten Ihres Unternehmens auf Fixh IT zu kommunizieren, den Status eines Tickets zu lesen, neue Reparaturen über ein Online-Formular anzulegen oder ein Ticket zu aktualisieren, wenn ein Techniker einen Auftrag als abgeschlossen markiert. Für ein Reparaturzentrum, das Dutzende oder Hunderte Reparaturen pro Monat abwickelt, kann diese Integration zwischen Smartphone- und PC-Reparaturen und externer Software den Unterschied zwischen einem reibungslosen Arbeitsablauf und einem voller manueller Doppeleingaben ausmachen.
In der Praxis
Jeder erstellte API-Schlüssel ist Ihrem Unternehmen zugeordnet (key_type „company") und ermöglicht es einem externen System, sich gegenüber den REST-v1-APIs von Fixh IT zu authentifizieren, indem der Schlüssel im X-API-Key-Header jeder HTTP-Anfrage enthalten ist. Mit diesem Schlüsseltyp können Sie die Liste der Reparaturen Ihres Unternehmens nach Filiale, Status oder Suchtext gefiltert abrufen, die Details einer einzelnen Reparatur lesen, neue anlegen, indem Sie Filiale, Kunde, Techniker, Gerät, festgestellten Schaden, übergebenes Zubehör und Kostenvoranschlag angeben, oder eine bestehende Reparatur aktualisieren, indem Sie Status, Zahlung, Auslieferung oder interne Notizen ändern. Jede Anfrage wird immer automatisch auf das Unternehmen gefiltert, dem der Schlüssel gehört: Ein externes System kann niemals Daten eines anderen Unternehmens im Netzwerk sehen oder ändern, nicht einmal versehentlich, da die Prüfung serverseitig bei jeder einzelnen Abfrage erfolgt.
Aus Sicherheitsgründen wird der vollständige Schlüssel (die eigentliche geheime Zeichenfolge) nur einmal auf dem Bildschirm angezeigt, direkt nach der Erstellung: Danach speichert das System nur einen Hash des Schlüssels und zeigt in der Liste ausschließlich dessen Anfangspräfix (key_prefix) an – ausreichend zum Wiedererkennen, aber nicht zur Wiederverwendung. Es ist daher unerlässlich, den Schlüssel sofort zu kopieren und in die Konfigurationsdatei des externen Systems einzufügen, das ihn verwenden soll, bevor Sie das Fenster schließen: Vergessen Sie das, bleibt nur die Möglichkeit, diesen Schlüssel zu widerrufen und einen neuen zu erstellen. Jeder Schlüssel zeigt außerdem sein Datum der letzten Nutzung an, was hilft zu erkennen, ob eine Integration noch aktiv ist oder ohne Bedenken deaktiviert werden kann, weil sie nicht mehr verwendet wird. Geht ein Schlüssel verloren, wird er kompromittiert oder nicht mehr benötigt, können Sie ihn jederzeit aus der Liste widerrufen: Nach dem Widerruf funktioniert er sofort nicht mehr, das Widerrufsdatum wird erfasst, und jedes System, das ihn verwendet hat, verliert augenblicklich den Zugriff auf die APIs, ohne dass anderswo eingegriffen werden muss.
Neben den Schlüsseln vom Typ Unternehmen gibt es im selben technischen System auch einen Schlüsseltyp, der den Wiederverkäufern im Fixh-IT-Netzwerk vorbehalten ist und zur automatischen Verwaltung der Ausstellung und Kontrolle von Lizenzcodes über deren eigene Verwaltungssoftware dient: Die beiden Schlüsseltypen sind vollständig getrennt (unterschiedliche Zugriffskontrollen, unterschiedliche Berechtigungen), und ein Unternehmensschlüssel kann niemals für Vorgänge verwendet werden, die Wiederverkäufern vorbehalten sind, und umgekehrt.
Kurzanleitung
- Gehen Sie zu Unternehmen > API-Schlüssel.
- Erstellen Sie einen neuen API-Schlüssel und geben Sie ihm einen beschreibenden Namen, der die Integration eindeutig kennzeichnet (zum Beispiel „Ersatzteil-Onlineshop" oder „WhatsApp-Support-Bot").
- Kopieren Sie sofort den auf dem Bildschirm angezeigten vollständigen Schlüssel: Er wird danach nicht mehr vollständig angezeigt, nur noch in maskierter Form.
- Fügen Sie den Schlüssel in die Konfigurationsdatei des externen Systems ein, in die für den X-API-Key-Header vorgesehene Variable.
- Konfigurieren Sie das externe System so, dass es den Schlüssel im X-API-Key-Header bei jeder Anfrage an /api/v1/company/repairs und die anderen verfügbaren Endpunkte sendet.
- Testen Sie die Integration mit einem Testaufruf, zum Beispiel dem Abrufen der Reparaturliste, um zu prüfen, ob die Antwort die erwarteten Daten enthält.
- Prüfen Sie regelmäßig das Datum der letzten Nutzung jedes Schlüssels, um nicht mehr aktive Integrationen zu erkennen.
- Widerrufen Sie den Schlüssel bei Bedarf aus der Liste, um seine Nutzung sofort zu beenden, etwa beim Wechsel des Website-Anbieters oder wenn Sie ein externes Tool nicht mehr nutzen.
Praxisbeispiele
Reparaturanfrage-Formular auf der Website. Eine Smartphone-Reparaturwerkstatt bindet auf ihrer Website ein Formular „Reparatur anfragen" ein: Füllt ein Kunde es aus, ruft ein externes Skript den Endpunkt zur Reparaturerstellung mit dem X-API-Key-Header auf und erzeugt automatisch ein neues Ticket im System, das bereits der richtigen Filiale zugeordnet und bereit ist, von einem Techniker übernommen zu werden – ohne dass jemand die Daten von der Website manuell in das System übertragen muss.
Synchronisation mit einer externen Buchhaltungssoftware. Ein Unternehmen mit mehreren Filialen nutzt für die Rechnungsstellung eine separate Buchhaltungssoftware: Eine geplante Integration liest jede Nacht über den API-Schlüssel die in den letzten 24 Stunden als bezahlt und ausgeliefert markierten Reparaturen aus und importiert sie zur steuerlichen Erfassung in das Buchhaltungssystem, wodurch die doppelte manuelle Dateneingabe entfällt.
Automatische Kundenbenachrichtigungen per Bot. Ein Reparaturzentrum verbindet einen Messaging-Bot mit seinem System: Ändert ein Techniker den Status einer Reparatur über die API von „in Bearbeitung" auf „abholbereit", prüft der externe Bot regelmäßig kürzlich aktualisierte Reparaturen und sendet dem Kunden automatisch eine Nachricht – das reduziert Anrufe im Geschäft, in denen nach dem Reparaturstatus gefragt wird.
Tipps und bewährte Praktiken
Erstellen Sie für jede Integration einen eigenen API-Schlüssel, statt überall denselben Schlüssel wiederzuverwenden: So können Sie, falls ein externes System außer Betrieb genommen oder kompromittiert wird, nur diesen einen Schlüssel widerrufen, ohne alle anderen Integrationen neu konfigurieren zu müssen. Geben Sie jedem Schlüssel einen beschreibenden Namen, der auf einen Blick zeigt, wofür er dient, besonders wenn Sie im Laufe der Zeit mehrere ansammeln. Prüfen Sie regelmäßig das Datum der letzten Nutzung, um „vergessene" Schlüssel zu Systemen zu erkennen, die Sie nicht mehr verwenden, und widerrufen Sie diese: Weniger aktive Schlüssel bedeuten eine kleinere Angriffsfläche. Bewahren Sie den vollständigen Schlüssel in einem Passwortmanager oder einer geschützten Konfigurationsdatei auf, niemals in einem geteilten Dokument oder einer Chat-Nachricht.
Häufige Fehler, die es zu vermeiden gilt
Teilen Sie niemals denselben API-Schlüssel zwischen mehreren verschiedenen Integrationen: Müssen Sie später eine davon deaktivieren, riskieren Sie, auch die anderen zu unterbrechen. Betten Sie den Schlüssel nicht direkt in den öffentlichen Quellcode einer Website oder App ein: Er sollte immer in einer separaten, nicht versionierten Konfigurationsdatei liegen. Erwarten Sie nicht, den vollständigen Schlüssel nach dem ersten Schließen des Fensters wiederherstellen zu können: Vergessen Sie das Kopieren, bleibt nur, ihn zu widerrufen und einen neuen zu erstellen. Vergessen Sie schließlich nicht, Schlüssel stillgelegter Integrationen zu widerrufen: Ein aktiver, aber ungenutzter Schlüssel bleibt ein potenzieller Zugangspunkt zu Ihren Reparaturdaten.
Mehr erfahren
- Fixh Assistant: der WhatsApp-Chatbot mit Fixh AI für Ihre Reparaturwerkstatt
- Firmen-Schaufenster: Verkaufen Sie Ihre Lagerprodukte online
- Alle Unternehmensdaten exportieren: Reparaturen, Dokumente, Kunden und Belege in einem ZIP-Archiv
Häufig gestellte Fragen
Kann ich den vollständigen Schlüssel nach der Erstellung erneut einsehen? Nein, aus Sicherheitsgründen wird der vollständige Schlüssel nur bei der Erstellung angezeigt; bei Verlust müssen Sie ihn widerrufen und einen neuen erstellen.
Was passiert, wenn ich einen API-Schlüssel widerrufe? Der Schlüssel funktioniert sofort nicht mehr, das Widerrufsdatum wird erfasst, und jede Anfrage, die ihn verwendet, wird vom System abgelehnt.
Kann ich mehrere API-Schlüssel für dasselbe Unternehmen erstellen? Ja, Sie können mehrere Schlüssel generieren, zum Beispiel einen pro Integration oder verbundenem externem System, und sie einzeln widerrufen, ohne die anderen zu beeinträchtigen.
Welche Daten kann ich mit einem Unternehmens-API-Schlüssel lesen oder schreiben? Die Reparaturen Ihres Unternehmens: Sie können sie auflisten, nach Filiale oder Status filtern, neue anlegen und Status, Zahlung, Auslieferung und interne Notizen bestehender Reparaturen aktualisieren, immer automatisch auf Ihr Unternehmen beschränkt.
Unterscheiden sich API-Schlüssel von denen, die Wiederverkäufer für Lizenzen verwenden? Ja, es gibt zwei vollständig getrennte Schlüsseltypen: Unternehmensschlüssel für Reparaturen und Wiederverkäuferschlüssel für die Verwaltung von Lizenzcodes, mit unterschiedlichen Berechtigungen und Geltungsbereichen.
Braucht man technisches Fachwissen, um API-Schlüssel zu nutzen? Ja, die Integration erfordert, dass das externe System (Website, Bot, Drittsoftware) so programmiert ist, dass es HTTP-Anfragen mit dem X-API-Key-Header sendet: Sie ist für Entwickler oder Softwareanbieter gedacht, die mit Ihrem Reparaturzentrum zusammenarbeiten.
