Allgemeiner Überblick über die SDK

Was ist unser SDK – Software Development Kit

Unser SDK (Software Development Kit) ist ein Set aus Programmierschnittstellen, Programmcode, Bibliotheken, Dokumentationen und Werkzeugen, das Entwicklern ermöglicht, neue Apps für tricoma zu erstellen.

Das SDK enthält ausführliche Dokumentationen, API-Beispiele, Code- und Prozessbeispiele sowie ein Tool, mit dem du neue Apps erstellen kannst. Dadurch kannst du neue Apps entwickeln, ohne jeden Teil des Codes von Grund auf neu schreiben zu müssen.

Video zur SDK

SDK Apps nur in der Staging-Umgebung

Alle genannten Funktionen und Apps sind ausschließlich in der Staging-Umgebung verfügbar. Eine Nutzung des SDK Master und der zugehörigen Vorlagen-Apps in der Live-Umgebung ist nicht möglich.

Unterschiedliche SDK Apps

Wir bieten mehrere SDK-Apps an, die einerseits zur Dokumentation und Verwaltung dienen, andererseits aber auch als Vorlage für die Entwicklung neuer Apps genutzt werden können. Nachfolgend stellen wir diese vor:

App: SDK Master

Die SDK Master App ist ein zentraler Bestandteil des SDK.

Apps einsehen und verwalten

Über diese App kannst du vorhandene Apps einsehen und verwalten.

Sie bietet außerdem die Möglichkeit, die Navigationsbereiche und Rechte jeder App einzusehen und zu verwalten.

Zusätzlich kannst du dir die SQL-Befehle zur Anlage einer App anzeigen lassen. Dadurch kannst du erstellte Apps einfach aus der Staging-Umgebung in das Live-System übertragen und installieren.

Zu jeder App steht dir außerdem eine Funktionsbibliothek zur Verfügung, die sogar deine eigenen Apps einliest, sodass selbst erstellte Funktionen dort verfügbar sind. In Zukunft sollen an dieser Stelle auch Funktionsdokumentationen bereitgestellt werden.

Neben jeder Funktion befindet sich außerdem ein Funktionsbutton, mit dem du den Quellcode der jeweiligen Funktion anzeigen kannst.

App-Anlage

Die App bietet außerdem die Möglichkeit zur App-Anlage, bei der andere SDK-Vorlagen als Grundlage verwendet werden können.

Mehr dazu findest du hier: Entwicklung einer neuen App per automatischen Appanlage

Gesamtes Funktionsverzeichnis

Es gibt außerdem ein komplettes Funktionsverzeichnis, in dem alle Funktionen des Systems verfügbar sind. Dort kannst du gezielt nach Funktionen suchen und dir den Quellcode aus verschiedenen Apps ansehen.

Funktionssuche über Maneta Search

Über die Maneta Search ist auch deine Funktionsbibliothek verfügbar. So kannst du einfach und schnell nach Funktionen suchen. Du musst dabei nicht den exakten Funktionsnamen eingeben – es genügen auch Teile davon.

Die Suche reagiert auf den Befehl: sdk Ihre Begriffe

Probiere es zum Beispiel mit:
sdk kunden anlegen

Auch hier kannst du die Suchergebnisse anklicken, um direkt zum entsprechenden Quellcode zu gelangen.

Bereitstellung einer Test-API

Die SDK Master App stellt für die weiteren SDK-Apps eine eigene Test-API bereit. Dadurch können alle Vorlagen-Apps auf einen Endpunkt zugreifen und komplette API-Abrufe – wie bei einem externen Aufruf – simuliert werden.

Das erleichtert die Entwicklung und das Verständnis für neue Apps erheblich.

Das Besondere dabei: Die API generiert sogar zufällig neue Daten, sodass auch neue Testkunden in der API verfügbar sind.

SDK Developer Masterclass – Videokurs zur tricoma-Entwicklung

In der SDK Master App findest du auch unsere Masterclass für Entwickler. Dort stehen dir über 45 Videos zum Thema Eigene Apps in tricoma entwickeln zur Verfügung.

Dieser Videokurs erleichtert dir den Einstieg erheblich.

App: SDK Minivorlage

Die Minivorlage ist eine kompakte Vorlage, die aus zwei Modulbereichen besteht:

• Einstellungen → Allgemeine Einstellungen vornehmen
• Tools → Abruf von Daten aus einer API

Die Vorlage simuliert eine App, die Produktpreise von einer externen API abruft und diese anschließend in einer CSV-URL aufbereitet bereitstellt. Diese CSV-URL kann in der App Import/Export eingebunden werden, um Preise automatisch zu aktualisieren. Weitere Details findest du hier: Zeitgesteuerter Import bzw. Export

Die App ist damit die ideale Grundlage, um beispielsweise Lieferanten-APIs anzubinden und gleichzeitig den Aufwand beim Import zu minimieren.

App: SDK Standardvorlage

Die Standardvorlage ist eine grundlegende und typische Verwaltungs-App. Sie enthält Einträge, die mit Kunden und Produkten verknüpft werden können. Zusätzlich kann eine Shortinfo generiert werden, und über die integrierte Statistik lassen sich verschiedene Auswertungen erstellen.

• Einstellungen → Allgemeine Einstellungen und Kategorieverwaltung
• Übersicht → Übersicht der Einträge mit Selektion und Archivierung
• Detailansicht → Detailansicht mit der Möglichkeit, Produkte einzutragen
• Tools → Allgemeines Tool, um den Status mehrerer Einträge gleichzeitig zu ändern
• Statistik → Statistik mit Balken- und Kreisdiagrammen
• Wizard- und Einrichtungsassistent-Kompatibilität
• Shortinfo-Kompatibilität

App: SDK Versandvorlage

Die Versandvorlage ist eine App-Vorlage zur Anbindung eines neuen Versanddienstleisters. Sie wird vollständig funktionsfähig ausgeliefert, sodass sogar über die interne API des SDK Master Versandlabels generiert werden können. Dadurch lässt sich der komplette Ablauf eines Versandlabels realistisch nachbilden.

• Einstellungen → Allgemeine Einstellungen, Schnittstellenverwaltung und Zuordnung der Carrier-Lieferarten zu den tricoma-eigenen
• Übersicht → Übersicht der Einträge mit Selektion, Archivierung, Stornierung einer Sendung und Label-Download
• Detailansicht → Detailansicht einer erstellten Lieferung
• Meldungen → Übersichtliche Ausgabe der Meldungen mit Filterfunktionen
• Tools → Allgemeines Tool zum Erstellen oder Stornieren neuer Labels
• Statistik → Statistik mit Balkendiagrammen
• Wizard- und Einrichtungsassistent-Kompatibilität
• Generierung von Druckscripten über den Einrichtungsassistenten
• Maneta Search mit Trackingcode- und Kundensuche
• Maneta Overview Datenübergabe
• Globale Debug-Log-Kompatibilität
• Ansicht im Kunden

App: SDK Zahlungsvorlage

Die Zahlungsvorlage ist eine App-Vorlage zur Anbindung eines neuen Zahlungsdienstleisters. Sie wird vollständig funktionsfähig ausgeliefert, sodass über die interne API fiktive Zahlungseingänge oder Erstattungen erstellt werden können.

• Einstellungen → Allgemeine Einstellungen, Schnittstellenverwaltung sowie Zuordnung und Anlage eines Eintrags in der App Bankkonten
• Übersicht → Übersicht der Einträge mit Selektion und Archivierung
• Detailansicht → Detailansicht eines Zahlungseingangs
• Meldungen → Übersichtliche Ausgabe der Meldungen mit Filterfunktionen
• Tools → Allgemeines Tool zum Abrufen von Zahlungen
• Statistik → Statistik mit Balkendiagrammen
• Wizard- und Einrichtungsassistent-Kompatibilität
• Rückerstattung von Zahlungen
• Maneta Search mit Zahlungsreferenz- und Kundensuche
• Maneta Overview Datenübergabe
• Globale Debug-Log-Kompatibilität
• Ansicht im Kunden
• Cronjob für den automatischen Import der Zahlungsströme

App: SDK Verkaufsvorlage

Die Verkaufsvorlage ist eine vollständig funktionsfähige App-Vorlage, mit der über die interne API fiktive Bestellungen abgerufen werden können.

• Einstellungen → Allgemeine Einstellungen, Schnittstellenverwaltung, Zuordnung und Automatismen
• Zuweisung von Versandarten, Zahlungsarten, Kategorien, Eigenschaften / Produktdatenfeldern
• Bestellungen → Übersicht der Bestellungen mit Selektion und Archivierung
• Positionen → Übersicht der Bestellpositionen
• Detailansicht → Detailansicht einer Bestellung
• Meldungen → Übersichtliche Ausgabe der Meldungen mit Filterfunktionen
• Tools → Allgemeines Tool als Trigger für Bestellabholung, Versandübermittlung, Produktvormerkung und Lagerbestandsabgleich
• Statistik → Statistik mit Balkendiagrammen
• KPI Dashboard → Charts über Bestellungen und Umsätze
• Wizard- und Einrichtungsassistent-Kompatibilität
• Maneta Search zur Suche nach Bestellnummern oder Transaktionsnummern
• Maneta Overview Datenübergabe
• Maneta Product Workflow Anbindung
• Globale Debug-Log-Kompatibilität
• Ansicht im Kunden und im Produkt
• Cronjob für den automatischen Import von Bestellungen, Versandübermittlungen, Produktübertragungen und Lagerbeständen

App: SDK Mod Ext

Diese Vorlage enthält Quellcodebeispiele zur Entwicklung von Modulerweiterungen. Sie zeigt, wie bestehende tricoma-Bereiche erweitert oder eigene Funktionen integriert werden können. Enthalten sind unter anderem folgende Beispiele:

• Ansicht im Kunden
• Ansicht im Produkt
• Ansicht im Mitarbeitermanagement
• Navigationspunkt/Bereich in der Scanstation
• Navigationspunkt/Bereich in der Scanstation MDE
• Navigationspunkt/Bereich in der Kasse
• Allgemeines Beispiel für einen externen Zugriff, z. B. für eine CSV-Datei
• ...

App: SDK Pluginvorlage

Diese Vorlage dient als Grundlage, um ein eigenes Plugin für tricoma zu entwickeln.

App: SDK Import/Export Vorlage

Diese Vorlage dient dazu, eine eigene Import- oder Exportvorlage in tricoma zu erstellen.

App: SDK Local API Vorlage

Beispielcode, um die App Local API Connector in eigenen Apps zu implementieren.

Nutzungsrechte

Mehr zum Thema Nutzungsrechte der SDK-Quellcodes findest du hier: Nutzungsrechte für Apps aus der SDK