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.

Für alle Kunden, die weiterhin unsere SOAP-API nutzen wollen, haben wir hier alle Informationen zu SOAP zusammengefasst inklusive Beispielen und einer Migrations-Anleitung von Version 2.0 auf 4.0.

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

Download OpenAPI specification: Download

API Definition

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 ist.

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/