Fax-API Konten verwalten 

Um unsere Fax-API nutzen zu können, müssen Sie über ein Fax-API-Konto verfügen.

Auf dieser Seite finden Sie Informationen zu den folgenden Punkten:

Konten verwalten

Im Menüpunkt „Fax-API Konten verwalten“ wird bei der Anmeldung automatisch ein Testkonto angelegt. Sie haben die Möglichkeit, dieses Testkonto über das Stiftsymbol zu bearbeiten oder über den Button „+ Neues Konto anlegen“ neue Fax-API-Konten anzulegen.

Neues Fax-API-Konto anlegen

Nachdem Sie auf den Button „+ Neues Konto anlegen“ geklickt haben, gelangen Sie zur Eingabemaske, in der Sie ein neues Konto anlegen können.
Bezeichnung Beschreibung
Konto Für den Fax-API-Kontonamen wählen Sie einen beliebigen Namen. Der Name dient zur Unterscheidung, falls Sie mehrere Fax-API-Konten anlegen und verwalten.
Faxvorlage speichern

Vorlage speichern: ja

Unter Auftragsübersicht können Sie die Details Ihrer Faxaufträge einsehen. Dazu gehören auch die Faxvorschau und Ihre Faxvorlage. Diese Dokumente werden nach 14 Tagen automatisch gelöscht, sofern keine andere Aufbewahrungsvereinbarung getroffen wurde.

Vorlage speichern: nein

Die Fax-Vorschau und Ihre Fax-Vorlage werden unmittelbar nach dem Abschluss des Fax-Versands gelöscht und können nicht mehr eingesehen werden.

Autorisierungs-Schlüssel

Beim Anlegen und Speichern des Fax-API-Kontos werden standardmäßig der Autorisierungs-Schlüssel und die notwendigsten Daten hinterlegt. Den Autorisierungs-Schlüssel benötigen Sie zwingend, um unsere Fax-API nutzen zu können.

Ihr Fax-API-Konto bietet Ihnen weitere Eingabemöglichkeiten. Beim Anlegen oder Bearbeiten Ihres Fax-API-Kontos finden Sie die Rubriken Basisdaten und Benachrichtigungen.

Für das Fax-API-Testkonto sind die folgenden Einstellungen voreingestellt. Während der Bearbeitung Ihres Fax-API-Kontos können Sie alle Einstellungen an Ihre Bedürfnisse anpassen.
Bezeichnung Beschreibung
Konto Für den Fax-API-Kontonamen wählen Sie einen beliebigen Namen. Der Name dient zur Unterscheidung, falls Sie mehrere Fax-API-Konten anlegen und verwalten.
Status Wenn Sie Ihr Konto erstellen, ist der Status aktiv. Sobald Sie den Status deaktivieren, wird er auf inaktiv gesetzt. Über inaktive Konten können keine Faxe mehr versendet werden. Sie können den Status jedoch jederzeit wieder aktivieren.
Autorisierungs-Schlüssel Der Autorisierungs-Schlüssel ist für jedes Fax-API-Konto eindeutig. Er wird bei der Einrichtung des Fax-API-Kontos hinterlegt.

Bei jedem Faxauftrag über unsere Fax-API wird der Autorisierungs-Schlüssel automatisch übermittelt und dient zur Authentifizierung und Zuordnung zu Ihrem Fax-API-Konto.
Kopfzeile Die Kopfzeile steht am oberen Rand (Kopf) von Textseiten und gibt dem Faxempfänger z.B. Auskunft darüber, von wem das Fax gesendet wurde.

Wenn Sie eine Kopfzeile wünschen, wählen Sie Kopfzeile – ja. Es öffnen sich zwei Eingabefelder. Im Eingabefeld Text 1 (Links) geben Sie die Daten ein, die in der Kopfzeile links stehen sollen. Ebenso verfahren Sie mit Text 2 (Mitte). Die in Text 2 eingegebenen Daten stehen dann in der Mitte der Kopfzeile.

Das dritte und vierte Feld der Kopfzeile werden vom System automatisch ausgefüllt. Im dritten Feld erscheint die Faxnummer des Empfängers und im vierten Feld die Seitenzahl.

weitere Informationen 
Station ID Die Station ID ist die Absenderkennung, die während der Übertragung angezeigt wird und auch im Empfangsprotokoll erscheint.

Die Station ID kann Buchstaben, Ziffern und folgende Sonderzeichen (+:;_- ) enthalten. Die Anzahl der Zeichen ist auf 20 begrenzt.
CLIP Die CLIP (englische Abkürzung für Calling Line Identification Presentation) ist die Rufnummer, die vor der Übertragung des Faxdokuments übermittelt wird.

Bitte teilen Sie unserem Support Ihre Absenderfaxnummern (CLIPs) mit. Die gewünschten Absenderfaxnummern stehen Ihnen dann nach Prüfung zur Auswahl zur Verfügung.
Standortvorwahl Die Standortvorwahl gibt an, welche Landesvorwahl Faxnummern ohne Landesvorwahl automatisch vorangestellt wird.

Haben Sie beispielsweise für ein Kundenprofil die Ortsvorwahl ‚0043‘ gewählt, wird beim Hochladen der Faxnummer ‚0525187929399‘ die führende Null automatisch durch die Ländervorwahl ‚0043‘ ersetzt.
Kostenstelle Die frei definierbaren Kostenstellen sind ein rein organisatorischer Bestandteil der Faxsuite.

Durch die Angabe von Kostenstellen haben Sie die Möglichkeit, die im Rahmen des Faxversands anfallenden Kosten direkt den Kostenstellen Ihres Unternehmens zuzuordnen.
Faxvorlage speichern

Vorlage speichern: ja

Unter Auftragsübersicht können Sie die Details Ihrer Faxaufträge einsehen. Dazu gehören auch die Faxvorschau und Ihre Faxvorlage. Diese Dokumente werden nach 14 Tagen automatisch gelöscht, sofern keine andere Aufbewahrungsvereinbarung getroffen wurde.

Vorlage speichern: nein

Die Fax-Vorschau und Ihre Fax-Vorlage werden unmittelbar nach dem Abschluss des Fax-Versands gelöscht und können nicht mehr eingesehen werden.

Sie können unsere Benachrichtigungsfunktion nutzen, um sich über die Ergebnisse Ihrer Faxaufträge informieren zu lassen.

Durch Anklicken des Buttons „+ Neue Benachrichtigung erstellen“ öffnet sich das folgende Eingabefenster.
Sie haben die Möglichkeit, die folgenden Benachrichtigungstypen per Drop-Down-Menü auszuwählen: E-Mail, E-Mail (XML) und URL-Aufruf. Es ist auch möglich, mehrere Benachrichtigungen für ein Mail2Fax-Konto zu definieren..

Typ: E-Mail

Eingabefeld Beschreibung
Typ  E-Mail
E-Mail-Adresse Geben Sie hier die E-Mail-Adresse ein, an die die Benachrichtigung gesendet werden soll. Nach Abschluss Ihres Faxauftrags erhalten Sie an die hinterlegte E-Mail-Adresse (Ziel) detaillierte Informationen über Ihren versendeten Faxauftrag und das Versandergebnis
Anhang Je nachdem, ob Sie Anhang ja oder nein gewählt haben, erhalten Sie das gesendete Fax als PDF-Anhang.
Benachrichtigung bei Im Feld „Benachrichtigung bei“ sind standardmäßig die Kästchen „Versand erfolgreich“ und „Versand fehlerhaft“ angekreuzt. In diesem Fall erhalten Sie nach jedem abgeschlossenen Faxversand die gewünschte Benachrichtigung.

Optional können Sie auch einen Haken entfernen. Sie erhalten dann nur eine Benachrichtigung für den abgeschlossenen Faxversand, bei dem Sie den Haken gesetzt haben.
Beispiel

Anhang: nein
Beispiel

Anhang: ja

Anhang

Versandbericht

Typ: E-Mail (XML)

Eingabefeld Beschreibung
Typ E-Mail (XML) Sie erhalten detaillierte Informationen über das Versandergebnis Ihres Faxauftrags als Textdatei (XML).
E-Mail-Adresse Geben Sie hier die E-Mail-Adresse ein, an die die Benachrichtigung gesendet werden soll. Nach Abschluss Ihres Faxauftrags erhalten Sie an die hinterlegte E-Mail-Adresse (Ziel) detaillierte Informationen über Ihren versendeten Faxauftrag und das Versandergebnis.
Benachrichtigung bei Im Feld „Benachrichtigung bei“ sind standardmäßig die Kästchen „Versand erfolgreich“ und „Versand fehlerhaft“ angekreuzt. In diesem Fall erhalten Sie nach jedem abgeschlossenen Faxversand die gewünschte Benachrichtigung.

Optional können Sie auch einen Haken entfernen. Sie erhalten dann nur eine Benachrichtigung für den abgeschlossenen Faxversand, bei dem Sie den Haken gesetzt haben.
Beispiel Beispiel: Textdatei (XML)

Typ: URL Aufruf

Eingabefeld Beschreibung
Typ URL Aufruf Der URL-Aufruf dient dazu, die Versandergebnisse pro Empfänger automatisiert in Ihr System zu importieren und weiter zu verarbeiten.
URL Bei Fragen wenden Sie sich bitte an unseren Support.
Benachrichtigung bei Im Feld „Benachrichtigung bei“ sind standardmäßig die Kästchen „Versand erfolgreich“ und „Versand fehlerhaft“ angekreuzt. In diesem Fall erhalten Sie nach jedem abgeschlossenen Faxversand die gewünschte Benachrichtigung.

Optional können Sie auch einen Haken entfernen. Sie erhalten dann nur eine Benachrichtigung für den abgeschlossenen Faxversand, bei dem Sie den Haken gesetzt haben.