Für Unternehmen: Zugang zu e-Box mittels Webservice

E-box in einen Webservice integrieren: für wen und warum

Bekommt Ihr Unternehmen große Dokumentenmengen in der e-Box? Wird es dadurch schwierig, Nachrichten in der Online-e-Box manuell zu verarbeiten? Dann kann Ihnen eine technische Integration der e-Box mittels eines Webservices von Nutzen sein.

Wenn Sie mit einem Webservice arbeiten, ruft Ihr internes IT-System alle Daten direkt aus der e-Box ab.

Ist Ihnen diese Integration ein Begriff? Dann schauen Sie sich unbedingt die untenstehende technische Dokumentation (neues Fenster) an.

So integrieren Sie e-Box: technische Dokumentation (DocConsumer)

Alle Informationen, die Sie für die Integration benötigen, finden Sie auf der Seite Integration als Dokumentenverbraucher (auf Englisch) (neues Fenster).

Werfen Sie auch mal einen Blick auf die Dokumentation (auf Englisch) in Swagger (openAPI 2.0) (neues Fenster).

Die zu erledigenden Schritte finden Sie auf Integrationsprozess zum Dokumentenverbraucher (auf Englisch) (neues Fenster)

Für Versender / Lieferanten: über die e-Box mit Unternehmen kommunizieren

Ihre Dokumente bei e-Box: 2 Optionen

Schickt Ihre Einrichtung regelmäßig Nachrichten an Unternehmen? Papier ist doch irgendwie von gestern … Entscheiden Sie sich lieber für die digitale Kommunikation mit der e-Box. e-Box ist benutzerfreundlich und sicher.

Es gibt 2 Möglichkeiten, wie sie bei e-Box mit Unternehmen kommunizieren können.

Weitere Informationen finden Sie in der technischen Dokumentation (auf Englisch) (neues Fenster).

Versender von Dokumenten werden

Als Versender von Dokumenten veröffentlichen Sie Ihre Dokumenten im Namen Ihrer Einrichtung zu Händen der Unternehmen, die Sie erreichen müssen. Ihre Dokumente werden während ihrer Gültigkeitsdauer (die Sie vorab festlegen) auf der e-Box-Infrastruktur der sozialen Sicherheit gehostet. Aus technischer Sicht veröffentlichen Sie Ihre Dokumente bei e-Box mittels eines Webservices.

Die zu erledigenden Schritte finden Sie auf Integrationsprozess zum Versender von Dokumenten (auf Englisch) (neues Fenster).

Lieferant von Dokumenten werden

Als Lieferant von Dokumenten wird Ihre Einrichtung zur Datenquelle für e-Box. Sie installieren einen Webservice, der den sicheren Zugriff auf Dokumente ermöglicht. Die Dokumente werden auf Ihrer eigenen Infrastruktur gehostet. Der Webservice muss die API RESTful (openAPI 2.0) der e-Box respektieren. Diese gilt als ein gemeinsamer Vertrag für alle Lieferanten von e-Box-Nachrichten.

Die zu erledigenden Schritte finden Sie auf Integrationsprozess zum Lieferant von Dokumenten (neues Fenster).

Webservice der Föderation der e-Box Enterprise

In diesem Webservice verwalten Sie die Nutzungspräferenzen eines Unternehmens für seine e-Box und die Liste der Dokumentenlieferanten (MessageProvider). Sie tun das auf der zentralen Ebene der Föderation der e-Box Enterprise.
Die verfügbaren Informationen in dieser Version sind:

  • eboxPreferences: Damit überprüfen Sie das Datum der letzten Konsultation und das Opt-in für die e-Box (exclusivelyEbox).
  • providerRegistry: Fordern Sie die Liste der documentProviders an und sehen Sie sich die technischen Informationen an, die für die Integration der Liste benötigt werden.

Achtung: Es gibt einen Patch für die providerRegistry, der jedoch nicht in dieser Version vorhanden ist.

Weitere Informationen finden Sie im Webservice der Föderation der e-Box Enterprise (auf Englisch) (neues Fenster).