Schnittstellenleitfaden: Unterschied zwischen den Versionen

Zur Navigation springen Zur Suche springen
← Zum vorherigen Versionsunterschied
 
(19 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 7: Zeile 7:
Im Folgenden werden die Austauschformate für die nicht spezifische Webshop-Schnittstelle aufgeführt. Die Schnittstelle ist eine von mehreren Schnittstellen, die genutzt werden können.
Im Folgenden werden die Austauschformate für die nicht spezifische Webshop-Schnittstelle aufgeführt. Die Schnittstelle ist eine von mehreren Schnittstellen, die genutzt werden können.


==Formate==
==Hinweise für externe Entwickler==
Neben den branchenspezifischen Schnittstellen (KOLLEX, OctopusOrder, Refill, Gastivo) unterstützt FAKTURA-X auch algemeine EDI Formate.
{{Achtung|Wir weisen explizit darauf hin, dass die vorliegende Schnittstelle seit vielen Jahren von verschiedenen Schnittstellenpartnern eingesetzt wird}}


{{Tipp1|Informationen dazu erhalten Sie vom Hersteller}}
Es handelt sich um eine '''praxiserprobte''' und '''erwiesenermaßen robuste, funktionsfähige Schnittstelle.''' Die Schnittstelle wurde mit Fachleuten aus mehreren Unternehmen gemeinsam entwickelt. Sie wurde '''bereits erfolgreich in Systeme wie "Shopware" oder "Drinkware" implementiert''' und '''wird im Produktivbetrieb von Anwendern genutzt:'''


==Formatkennzeichen==
* Die Schnittstelle ist voll funktionsfähig
* A: String (Zeichenkette alphanumerisch), Länge wird zusätzlich angegeben
* Alle zugrundeliegenden Normen und Spezifikationen werden eingehalten
* N: Float (Numerisch), Wertebereich optional angegeben
* I: Integer (Ganzzahl), Wertebereich optional angegeben
* B: Boolean (Logisch), Wertebereich (FALSCH, WAHR)
* D: Date (Datum), Format [TT.MM.JJJJ]
* T: Time (Uhrzeit), Format [HH:NN:SS]
* @: DateTime (Zeitstempel), Format [TT.MM.JJJJ HH:NN:SS]


==Abweichende Definitionen==
'''Daraus folgt:'''
Sollte eine Anforderung mit diesem Leitfaden nicht abgedeckt werden können, sprechen Sie uns bitte an.


{{Tipp1|Eine Anpassung oder Erweiterung ist nach Absprache kostenpflichtig möglich.}}
* Es werden '''keine Anpassung''' aufgrund von Einschränkungen oder Inkompatibilitäten auf der Seite des Shopsystems durchgeführt, auch nicht auf Anfrage oder gegen Kostenerstattung
* Eine '''Erweiterung''' der Schnittstelle ist auf Anfrage und in jedem Fall kostenpflichtig, möglich.
* Es muss nicht die Schnittstelle, sondern immer das Shopsystem angepasst werden. Dies ist nicht Aufgabe des Schnittstellenanbieters, sondern des Webshopentwicklers.
 
{{Achtung|Sie erhalten auf Anfrage Hilfestellung zu Schnittstellendefinitionen, jedoch keinesfalls zu branchenspezifischen Themen. Zu branchenspezifische Themen sprechen Sie ausschließlich den Auftraggeber an}}
 
Vor der Implementierung fordern wir beim Auftraggeber eine Freigabe zur Erstattung der Beratungskosten an.
Der entstandenen Aufwand wird dokumentiert.
 
==Dateiformate==
 
'''[[wikipedia:de:CSV_%28Dateiformat%29|CSV-Dateien]]'''
* Es werden deutsche Formatierungen und Zeichensätze verwendet
* Zeichensatz ist UTF-8
* Spalten werden, '''durch Semikola getrennt'''
* Jeder Datensatz wird '''mit einem Semikolon abgeschlossen'''
* Es werden '''keine Delimiter''' verwendet, der Typ eines Datensatzes ergibt sich aus der Reihenfolge
 
'''[[wikipedia:de:Extensible_Markup_Language|XML-Dateien]]'''
* RFC- und W3C-konform
* Zeichensatz ist UTF-8
 
==Dateitransfer==
Im einfachsten Fall werden Stammdaten als [[wikipedia:de:CSV_%28Dateiformat%29|CSV]]-Daten bereitgestellt und auf einen [[wikipedia:de:File_Transfer_Protocol|FTP]]-Server übertragen. Die Auftragsdaten werden als [[wikipedia:de:Extensible_Markup_Language|XML]]-Dateien von einem FTP-Server heruntergeladen und verarbeitet. Das Abrufen
 
* Das ''[[wikipedia:de:File_Transfer_Protocol|FTP-Protokoll]]'' wird RFC- und W3C-konform angewendet.
* Der FTP-Client der Anwendung arbeitet im passiven Modus, es wird der Standardport verwendet
* Die Anmeldung am Server erfolgt mit einem Benutzernamen und einem Passwort.
* Der Befehlssatz des Servers muss ASCII, CWD, DELE, GET, NLST und STOR umfassen<ref>https://en.wikipedia.org/wiki/List_of_FTP_commands</ref>
 
{{Tipp1|Neben den branchenspezifischen Schnittstellen (KOLLEX, OctopusOrder, Gastivo) unterstützt die Anwendung auch EDI-Formate}}


==Bereitstellung von Daten==
==Bereitstellung von Daten==
Im einfachsten Fall werden Stammdaten als [[wikipedia:de:CSV_%28Dateiformat%29|CSV]]-Daten bereitgestellt und auf einen FTP-Server übertragen. Die Auftragsdaten werden als [[wikipedia:de:Extensible_Markup_Language|XML]]-Dateien von einem FTP-Server herutergeladen und verarbeitet. Das Abrufen und Verarbeiten der Aufträge kann automnatisch oder manuell erfolgen.
Im einfachsten Fall werden Stammdaten als [[wikipedia:de:CSV_%28Dateiformat%29|CSV]]-Daten bereitgestellt und auf einen [[wikipedia:de:File_Transfer_Protocol|FTP]]-Server übertragen. Die Auftragsdaten werden als [[wikipedia:de:Extensible_Markup_Language|XML]]-Dateien von einem FTP-Server herutergeladen und verarbeitet. Das Abrufen und Verarbeiten der Aufträge kann automnatisch oder manuell erfolgen.


* Informationen für die Auftragsverarbeitung finden Sie [[Aufträge_importieren|hier]].
* Informationen für die Auftragsverarbeitung finden Sie [[Aufträge_importieren|hier]].
* Die Einstellungen für für den Datenaustausch mit WEBDRINK finden Sie [[WEBDRINK-Schnittstelle|hier]].
* Die Einstellungen für für den Datenaustausch mit WEBDRINK finden Sie [[WEBDRINK-Schnittstelle|hier]].
* Die Einstellungen für für den Datenaustausch mit Shopware oder Magento u.ä. finden Sie  [[Webshop-Schnittstelle|hier]].
* Die Einstellungen für für den Datenaustausch mit Shopware oder Magento u.ä. finden Sie  [[WEBDRINK-Schnittstelle|hier]].


==Stammdatenexport als CSV==
==Stammdatenexport als CSV==
Die Daten werden mit einer FTP-Verbindung übertragen. Nach erfolgreichem Verbindungsaufbau werden die [[wikipedia:de:CSV_%28Dateiformat%29|CSV]]-Daten in einem zu definierenden Ordner kopiert.
Die Daten werden mit einer FTP-Verbindung übertragen. Nach erfolgreichem Verbindungsaufbau werden die [[wikipedia:de:CSV_%28Dateiformat%29|CSV]]-Daten in einem zu definierenden Ordner kopiert.


'''Folgende Standards werden vereinbart:'''
===Formatkennzeichen===


* Daten werden durch Semikola getrennt, bereitgestellt. Jeder Datensatz wird mit einem Semikolon abgeschlossen.
{| class="wikitable"
* Es werden keine Delimiter verwendet, der Typ eines Datensatzes ergibt sich aus der Reihenfolge.
! Zeichen !! Bedeutung !!Format
* Der Zeichensatz ist Windows 1252 (ANSI).
|-
 
| A || Eindimensionaler String || UTF-8, ohne Delimiter
{{Tipp1|Eine Anpassung oder Erweiterung ist nach Absprache kostenpflichtig möglich.}}
|-
| N || Gleitkommazahl || (-)n0,n, maximal 32-Bit
|-
| I || Ganzzahl || (-)i, maximal 32-Bit
|-
| B || Logischer Wert || True/False oder Wahr/Falsch, ohne Delimiter
|-
| D || Datum || ISO 8601 JJJJ-MM-TT, Zeitanteil wird ignoriert
|-
| T|| |Uhrzeit || ISO 8601 hh:nn:ss, Millisekunden werden ignoriert
|-
| @ || Zeitstempel || JJJJ-MM-TT hh:nn:ss, Millisekunden werden ignoriert
|}


===Feldbeschreibungen Datei "Kunden.csv“===
===Feldbeschreibungen Datei "Kunden.csv“===
Zeile 786: Zeile 821:
  </order>
  </order>
  </xml>
  </xml>
= Einzelnachweise =
<references />
Abgerufen von „https://wiki.fakturax.de/index.php?title=Schnittstellenleitfaden“