Simple Fax Modul

Beschreibung

Das simplefax-de-client-Modul bietet die einfache Möglichkeit, Faxe direkt aus Node.js-Anwendungen zu versenden, für https://simple-fax.de/. Der Dateipfad der gesetzt wird, muss in das Base64 Format umgewandelt werden!

Dieses Modul ist ideal für Unternehmen oder Einzelpersonen, die digitale Faxlösungen in ihre Workflows integrieren möchten. Es reduziert den Bedarf an physischen Faxgeräten und ermöglicht einen automatisierten Versandprozess.

Installation

Stelle sicher, dass Node.js installiert ist. Dann einfach die Abhängigkeiten mit folgendem Befehl installieren:

npm install simplefax-de-client

Verwendung

Hier ist ein Beispiel, wie das Modul genutzt werden kann:

const { sendFax } = require("simplefax-de-client");
const fs = require('fs');

const filePath = "Pfad zur PDF oder PS";

// Datei lesen und in Base64 umwandeln
fs.readFile(filePath, (err, data) => {
    if (err) {
        console.error("Fehler beim Lesen der Datei:", err);
        return;
    }

    const base64Data = data.toString('base64');

    const faxOptions = {
        faxnumber: "053149059113", // Ziel-Faxnummer (nationales Format)
        password: "Password hier", // Passwort für den Login
        username: "E-Mail hier.", // E-Mail für den Login
        data: base64Data, // Base64-kodierte Datei
        statusurl: "https://test.de/", // Optionale Status-URL (muss aber gesetzt sein!)
        filetype: "PDF", // Dateiformat (PDF oder PS)
        identifier: "Mein Name" // Optionale Identifikation des Senders
    };

    // Fax senden
    sendFax(faxOptions)
        .then(response => {
            console.log("Fax erfolgreich gesendet:", response);
        })
        .catch(error => {
            console.error("Fehler beim Senden des Faxes:", error);
        });
});

Parameter

| Parameter | Typ | Beschreibung | |--------------|--------|-------------| | faxnumber | String | Faxnummer im nationalen Format (ohne Ländervorwahl) | | password | String | Passwort für den Login beim Fax-Dienst | | username | String | E-Mail-Adresse für den Login | | data | String | Base64-kodierte Datei, die versendet wird | | statusurl | String | URL zur Statusrückmeldung, falls gewünscht | | filetype | String | Dateiformat der zu sendenden Datei ("PDF" oder "PS") | | identifier | String | Name oder Identifikation des Senders |

Preise

Simple-Fax berechnet pro erfolgreichen API Call (das bedeutet, sobald ein FAX gültig verlassen wurde) 0.07€ vom Guthaben. Stelle sicher, dass immer genügend Guthaben vorhanden ist, sonst funktioniert das Modul nicht.

Wo sehe ich wenn ein API-Call erfolgreich war?

Hier im Beispiel wird dir eine response zurückgeliefert mit der ID, die Simple-Fax mitteilt. Es wird auch die statusurl aufgerufen. Alternativ kann auch im Dashboard nachverfolgt werden, unter "Kontoeinstellungen" -> "Kontostand" -> "Kontoauszug"

Vorteile

• Einfache Integration: Kann direkt in bestehende Node.js-Projekte eingebunden werden.
• Automatisierung: Ermöglicht den automatisierten Versand von Faxen ohne manuelles Eingreifen.
• Flexibel: Kann mit verschiedenen Dateitypen genutzt werden.
• Statusverfolgung: Optional kann eine Status-URL angegeben werden, um den Fax-Status zu überprüfen.

Fehlerbehebung

Falls Probleme auftreten, können folgende Schritte helfen:

1. Dateipfad überprüfen: Stelle sicher, dass die Datei existiert und korrekt angegeben wurde.
2. Netzwerkverbindung prüfen: Der Fax-Dienst benötigt eine aktive Internetverbindung.
3. Zugangsdaten überprüfen: Stelle sicher, dass Benutzername und Passwort korrekt sind.
4. Base64-Konvertierung testen: Falls das Fax nicht ankommt, überprüfe, ob die Datei korrekt als Base64 umgewandelt wurde.

Lizenz

Dieses Modul kann frei verwendet und angepasst werden. Bei Fragen oder Verbesserungsvorschlägen einfach ein Issue im Repository erstellen.