Collmex API: Überblick

Das Collmex API bietet die Möglichkeit, Daten mit den Collmex-Programmen automatisch auszutauschen. Mögliche Szenarien sind z.B. die Anbindung von externen Shops, Rechnungs-Programmen oder Kassen.

Die verwendeten Datentypen basieren auf den CSV-Dateien, die auch für den interaktiven Upload verwendet werden. Die hier zusätzlich definierten Satzarten finden nur im API Verwendung und ergänzen die bekannten Satzarten für den Upload.

Das Kommunikationsprotokoll ist ein einfaches HTTP-POST, mit dem die Daten im CSV-Format (text/csv) hoch geladen werden. Als Ergebnis werden wiederum Daten im CSV-Format zurück gegeben. In einem Upload können beliebig viele Satzarten enthalten sein.

Mit dem frei erhältlichen Kommandozeilenprogramm cURL, können die CSV-Dateien auf sehr einfache Weise ausgetauscht werden. Für PHP existiert eine Bibliothek libcURL. Die Verwendung von cURL ist nur ein Beispiel, wie die Kommunikation technisch erfolgen kann. Natürlich kann jedes andere Programm verwendet werden, das Dateien per HTTP-POST übertragen kann.

Die URL für den Datenaustausch ist: https://www.collmex.de/cgi-bin/cgi.exe?XXXXX,0,data_exchange wobei XXXXX die Kunden- bzw. Mandantennummer ist.

Beispiel für einen Datenaustausch mittels cURL per Kommandozeile: curl -k -o download.csv --data-binary @upload.csv -H "Content-Type: text/csv" https://www.collmex.de/cgi-bin/cgi.exe?XXXXX,0,data_exchange.

In PHP:

  $ch = cURL_init("https://www.collmex.de/cgi-bin/cgi.exe?XXXXX,0,data_exchange");
  cURL_setopt($ch, CURLOPT_POST, 1); 
  cURL_setopt($ch, CURLOPT_POSTFIELDS, "LOGIN;user;password\nCUSTOMER_GET;9999;1\n");
  cURL_setopt($ch, CURLOPT_HTTPHEADER, Array("Content-Type: text/csv")); 
  cURL_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
  cURL_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
  $message = curl_exec($ch);
  echo cURL_error($ch);
  cURL_close($ch);
  echo str_replace("\n", "<br>", $message);

Von Partnern wurden SDK's für PHP und node.js zur freien Verwendung veröffentlicht. (Nutzung ohne Gewähr).

Siehe auch: Collmex API Inhalt