In diesem Artikel findest Du häufig gestellte Fragen und Antworten zur Craftnote-Schnittstelle (API), darunter Informationen zu Kosten, Sicherheit, Einrichtung, Leistungsumfang und technischer Dokumentation.
Welche Kosten kommen auf mich zu?
Die Kosten können sich aus zwei Blöcken zusammensetzen:
- Craftnote erhebt für die aktuelle Schnittstelle keine Kosten - erweiterte Funktionen oder kundenspezifische Anpassungen können Kosten verursachen
- Um unsere Webhooks nutzen zu können benötigt man das Büro Paket
- Der Anbieter der Branchen-Software kann eine Anschluss- und/oder Lizenzgebühr erheben. Darauf hat Craftnote keinen Einfluss, daher kann die Höhe individuell variieren
Wie steht es um die Sicherheit bei der Übertragung?
Der Zugriff auf das System von Craftnote via API ist mit speziellen Zugangsdaten für die Schnittstelle abgesichert. Die Zugangsdaten werden von uns für jede Firma festgelegt und nach der Freischaltung der Schnittstelle an den Kunden übermittelt. Im Betrieb werden die Daten aus der Handwerker Software über eine sichere https - Verbindung übertragen.
Ich habe meine eigene Software. Kann ich die Schnittstelle trotzdem verwenden?
Ja, das ist möglich. Über diesen Link können über die Web-App eigenständig API-Keys für Deine Firma erstellt werden. Der API-Key ist der Schlüssel, der benötigt wird, um die API-Verbindung zu aktivieren. Diese Erstellung kann allerdings nur vom Nutzer mit der Inhaber-Rolle des Betriebes durchgeführt werden.
Wo finde ich die technische Beschreibung für die Schnittstelle?
Auf der Entwickler-Plattform GitHub stellen wir immer die aktuelle Version der technischen Beschreibung bereit. Dokumentation ansehen
Wie kann ich auf die Craftnote API zugreifen?
Du als Nutzer von Craftnote, kannst nicht einfach selbst auf die API zugreifen und diese nutzen beziehungsweise einrichten. Hierfür ist eine Partnerfirma, wie zum Beispiel das eigene ERP-System notwendig. Die Daten aus dem ERP-System müssen dann programmatisch zu Craftnote (über die Schnittstelle) geschickt werden. Die Schnittstelle ist so gebaut, das sie unabhängig von der Programmiersprache gebaut und verbunden werden kann.
Wie kann ich über die API auf meine Projektdaten in Craftnote zugreifen?
In der Schnittstelle gibt es für die Projekte und für jede weitere Funktion sogenannte Endpunkte. Jede Funktion entspricht damit einem Endpunkt. Für das Erstellen eines Projektes und den damit verbunden Kopfdaten (Projektname, ID-Nummer, Adresse, Ansprechpartner) gibt es einen Endpunkt genau wie für die Dateiablage oder die Zeiterfassung. Der Endpunkt wird über /projects angesprochen. Die Details hierzu sind in der Schnittstellenbeschreibung hinterlegt.
Wie erfolgt der Ablauf der Einrichtung?
Du als Nutzer von Craftnote fragst bei deinem Softwarepartner nach, ob eine Schnittstelle existiert oder schaust auf unserer bestehenden Schnittstellenpartner-Webseite nach, ob dessen Software aufgeführt wird.
Wenn eine Schnittstelle besteht, wende Dich bitte direkt an den aufgeführten Kontakt, um die Einrichtung und die Details zu klären. Sollte noch keine Schnittstelle vorhanden sein, bitten wir Dich mit deinem Dienstleister oder Ansprechpartner vom ERP-System in Kontakt zu treten, um herauszufinden ob einen Schnittstelle gewollt ist.
Wir positionieren und klar als offenes System das den Austausch möchte, aber um ein funktionierendes System zu entwickeln braucht es auch die andere Seite.
Also von wo kommen die Daten und werden diese zu Craftnote übermittelt. Wenn Dein Softwarepartner eine Schnittstelle entwickeln möchte (dies ist oftmals mit Kosten verbunden. Wie hoch diese sind hängt vom Softwarepartner ab und nicht von Craftnote) dann kannst Du dich erneut an uns unter hilfe@mycraftnote.de wenden. Wir begleiten Dich und Deinen Softwarepartner dann gerne bei der Implementierung. (Projektplanung und Umsetzung)
An wen wende ich mich bei Fragen zu Anpassungen bzw. neuen Funktionen?
Unsere Kollegen sind unter hilfe@craftnote.de erreichbar und beantworten gerne Fragen zu einem möglichen Ablauf einer Entwicklung.
Wie kann ich Fehler, die während der Kommunikation mit der API auftreten, behandeln?
Unsere API liefert automatisch sogenannte Logs, die die Art des Fehlers beschreiben. Sollten wirklich Probleme auftauchen, kannst Du dich gerne jederzeit unter hilfe@craftnote.de an uns wenden und wir kümmern uns um Dein Anliegen.
Welchen Leistungsumfang umfasst die API?
- Anlegen, Verändern und Archivieren von Projekten (inklusive aller Kopfdaten). Projekte können auch aus Craftnote ausgelesen werden, sodass neue Informationen aus Projekten zurückübertragen werden können
- Verwaltung von Projektmitgliedern (nur intern): Mitarbeiter können mithilfe der API zu Projekten hinzugefügt und entfernt werden
- Verwaltung des Projektstatus: Es können neue Status angelegt, bestehende editiert und gelöscht werden
- In der Projekt-Dateiablage können Dateien und Ordner erstellt, verschoben und aktualisiert werden (Löschen ist nicht möglich). Die Dateien können dann auch in ein externes Softwaresystem (z.B. ein ERP-System) übertragen werden. Auch die Zugriffsverwaltung ist hierüber möglich
- Zu Projekten können Zeiten erstellt, verändert und gelöscht werden. Die erfassten Projektzeiten können dann auch ausgelesen werden, um damit Rechnungen zu schreiben und die Lohnabrechnung zu finalisieren
Weitere Informationen findest Du auch auf unserer Webseite.
Gut zu wissen
- Die API-Erstellung kann nur vom Nutzer mit der Inhaber-Rolle des Betriebes durchgeführt werden
- Die technische Dokumentation zur Schnittstelle ist auf GitHub verfügbar
- Bei Fragen zur Schnittstelle erreichst Du das Team unter schnittstelle@mycraftnote.de