restful
Schnellzugriff
Schnellzugriff

RESTful-API


Unsere neue Fax-API 4.0 beinhaltet neben einer weiter entwickelten SOAP-API nun auch eine RESTful-API. Auf den folgenden Seiten finden Sie Informationen zu unserer RESTful-API inklusive Beispielen.

Bei Fragen wenden Sie sich einfach an unser Support-Team.

Download OpenAPI specification: Download



API Definition

OpenAPI Logo

Die RESTful-API basiert auf den OpenAPI v3.0.3 Spezifikationen.

OpenAPI Spezifikationen (OAS) definieren eine standardisierte und programmiersprachenunabhängige Schnittstellenbeschreibung für RESTful-APIs.

Diese Schnittstelle ist nutzbar, ohne dass der Zugang zum Quellcode, zusätzliche Dokumentation oder die Untersuchung des Netzwerk-Traffics erforderlich sind.

Somit kann ein Nutzer den Dienst mit einem Minimum an Implementierungslogik verstehen, mit ihm interagieren und einfach und schnell als API-Schnittstelle in seine eigene Softwareanwendung integrieren.

Weitere Informationen zu OpenAPI finden Sie hier: https://www.openapis.org


Einleitung

Die standardisierte API-Dokumentation wird Ihnen in zwei unterschiedlichen Varianten angeboten:

  1. 1. nicht interaktiv
  2. 2. interaktiv

Name Type Link
Redoc non interactive https://service.fax-api.de/4.0/rest/
Swagger UI interactive (self hosted) https://service.fax-api.de/4.0/rest/swagger-ui/

Noch heute kostenlos testen!

Einfach anmelden und starten!

RESTful Clients

Hier erhalten Sie RESTful Client Codebeispiele. Folgen Sie den Kommentaren im Code um schnell und einfach bestimmte Funktionalitäten zu testen oder in Ihrem Code einzubinden.

Programmiersprache Download
PHP (curl)
download
PHP (file_get_contents)
download

Ist Ihre Programmiersprache nicht aufgelistet, dann sprechen Sie uns gerne an und wir versuchen auch für Ihre Programmiersprache einen Client zur Verfügung zu stellen.

Benötigen Sie Hilfe?

Kontaktieren Sie uns!

Vorteile der OpenAPI?

Eine standardisierte Dokumentation!

ZUM REDOC

Faxvorlagetypen


Folgende Dokumententypen können über die Fax-API als Faxvorlage versendet werden:


Dokumententyp Mimetype
PDF application/pdf
HTML text/html
Klartext text/plain
PNG image/png
GIF image/gif
TIFF image/tiff
Erstellt in wenigen Schritten

Noch keinen Testzugang?

So einfach geht das!

Online-Hilfe


Faxi

Hi, ich bin Faxi - deine ONLINE-HILFE.
Brauchst du Hilfe oder mehr Informationen?
Klick mich an.



Themenseiten unserer Online-Hilfe


Faxi Sandbox
Faxi Ergebnis-Codes