Die Fax-API ist ein SOAP basierte Schnittstelle zur automatisierten Einplanung und Steuerung von Faxsendungen.
Das Ziel der Fax-API ist die Bereitstellung eines WS-I kompatiblen SOAP-Webservices, der mit verschiedenen Programmiersprachen angesprochen werden kann.
Obwohl der Service derzeit mit dem Schwerpunkt PHP angeboten wird, kann die Schnittstelle auch in Java- und .Net-Anwendungen integriert werden.
Für Informationen zu anderen Programmiersprachen wenden Sie sich bitte an den Fax-API-Support.
Die Fax-API setzt sich aus zwei Servicebereichen zusammen:
SendFax − umfasst alle Serviceoperationen, die der Erzeugung von Aufträgen zum Faxversand dienen
Job − umfasst alle Serviceoperationen zur Verwaltung bereits erzeugter Faxaufträge
Für beide Services gibt es spezifische Service-Endpunkte und Dokumentationen, welche Sie im Folgenden finden.
| Produktive Endpunkte | Sandbox Endpunkte |
|---|---|
| Fax-API 2.0 | Fax-API 2.0 |
| https://soap.fax-api.de/2.0/sendfax.php?wsdl
https://soap.fax-api.de/2.0/job.php?wsdl |
https://sandbox.fax-api.de/2.0/sendfax.php?wsdl
https://sandbox.fax-api.de/2.0/job.php?wsdl |
| Fax-API 4.0 | Fax-API 4.0 |
| https://service.fax-api.de/4.0/soap/sendfax.php?wsdl
https://service.fax-api.de/4.0/soap/job.php?wsdl |
https://sandbox.fax-api.de/4.0/soap/sendfax.php?wsdl
https://sandbox.fax-api.de/4.0/soap/job.php?wsdl |
Mit der Standardversion der Client-Library für PHP & SOAP steht Ihnen eine stabile Ausgangsbasis für die Entwicklung einer individuellen Client-Library zur Verfügung.
1) Laden Sie die Client-Library herunter.
2) Entpacken Sie die ZIP-Datei auf Ihrem Webserver
3) Includen Sie die Library-Bestandteile in Ihre Anwendungen
4) Entwickeln Sie die Library nach Ihren Bedürfnissen weiter
 |
Client Library Fax-API 4.0 | ||
|
Client Library Fax-API 2.0 | ||
| Einige Beispiele finden Sie hier. | |||
 |
Client Library Installation | ||
Der SOAP Teil der Fax-API 4.0 ist eine Weiterentwicklung der Version 2.0.
Hierbei wurden Rechtschreibfehler korrigiert und kleinere Anpassungen durchgeführt.
Alle für die Migration von Version 2.0 auf Version 4.0 relevanten Änderungen, finden Sie
in der folgenden Tabelle.
| Name | Type |
|---|---|
| Namensanpassung | Typ "AuthentificationException" umbenannt zu "AuthenticationException" |
| Namensanpassung | Typ "CheckAuthentificationRequest" umbenannt zu "CheckAuthenticationRequest" |
| Namensanpassung | Typ "CheckAuthentificationResponse" umbenannt zu "CheckAuthenticationResponse" |
| Parameteranpassung | Im Typ JobOptions wurde der Parameter "ecodiscount" entfernt |
| Parameteranpassung | Im Typ JobOptions wurde der Parameter "timetosendUntil" hinzugefügt |
| Fehlerhandling | Der Jobs Endpunkt wirft nun auch die LimitExceededException |
| Ergänzung | Parameter "TimeToSentUntil" hinzugefügt |
Neben den Änderungen an der SOAP API haben sich auch die Endpunkte geändert.
Eine Gegenüberstellung der Endpunkte finden Sie in der folgenden Tabelle:
| Bereich | Fax-API 2.0 | Fax-API 4.0 |
|---|---|---|
| Sandbox | http://sandbox.faxsuite.de/soap | https://sandbox.fax-api.de/4.0/soap |
| Produktiv | http://www.fax-api.de//soap | https://service.fax-api.de/4.0/soap |