APIs
Eigene Anwendungen auf Basis Ihres Archivs
Zwei REST-APIs. Die User API arbeitet im Namen einer Person, mit genau deren Berechtigungen. Die System API arbeitet für Ihr Unternehmen. Wir haben unsere eigenen Apps darauf gebaut, die APIs sind also erprobt.
Benutzer-API
Ihre App im Archiv einer Person
Für Apps und KI-Assistenten, die im Namen einer Person arbeiten. Diese sehen, was die Person sieht, und nicht mehr.
Arbeitet im Namen einer Person
Jeder Aufruf läuft mit den Berechtigungen der angemeldeten Person und unterliegt denselben Regeln wie die Weboberfläche, von Vertretungen über private Dokumente und Facharchive bis zu Attributrechten. Ein Dokument, das jemand nicht sehen darf, gibt es für die App schlicht nicht. Mit Administratorkonten ist eine Anmeldung an der App gar nicht möglich.
Standard-OAuth 2.0, sauber umgesetzt
Apps melden sich über den Authorization Code Flow mit PKCE an, Desktop- und Mobil-Apps brauchen also keinen geheimen Schlüssel. Geben Sie Ihrer OAuth-Bibliothek eine einzige Discovery-Adresse an, und sie konfiguriert sich selbst. Zugriffstoken gelten fünfzehn Minuten, und kein Schlüssel landet je in einem Link.
Wir haben EMA Scan Client darauf entwickelt
Unsere eigene Scan-App meldet sich an und archiviert über genau die User API, die auch Sie erhalten. Sie läuft jeden Tag bei unseren Kunden. Wenn wir darauf ein echtes Produkt bauen können, können Sie das auch.
Mehr zu EMA ScanSuchen und lesen
Suchen wie in der Weboberfläche, gespeicherte Suchen nutzen und den Text jedes Dokuments lesen, das die Person sehen darf.
Originale herunterladen
Ein Dokument so abrufen, wie es archiviert wurde, oder eine E-Mail über ihre Message-ID finden.
Aus Ihrer App archivieren
Dateien hochladen, Nachrichten archivieren und Scans im eigenen Archiv der Person ablegen.
Attribute lesen und schreiben
Rechnungsnummern, Projekte oder Schlagwörter eintragen, nach den Regeln, die Sie für jedes Attribut festlegen.
Nur was die App braucht
Geben Sie jeder App nur die Berechtigungen, die sie braucht. Mit „Suchen und lesen“ allein kann sie nichts herunterladen, archivieren oder ändern.
Für die Personen Ihrer Wahl
Eine App auf bestimmte Personen oder Verzeichnisgruppen beschränken; EMA prüft das bei jeder Anmeldung erneut.
Mit einem Klick entzogen
Schalten Sie eine App ab oder machen Sie alle ihre Tokens ungültig, dann endet der Zugriff beim nächsten Aufruf.
Protokolliert
Jede App-Registrierung und jede Attributänderung landet im Sicheren Log. Auf Wunsch protokollieren Sie auch jede API-Anfrage.
Wie eine App Zugang erhält
App registrieren
Ein Administrator legt die App in EMA an und wählt ihre Berechtigungen und die Rücksprungadresse.
Einmal anmelden
Die Person meldet sich mit ihrem gewohnten EMA-Konto an, mit Single Sign-on, wo Sie es nutzen.
Im Namen dieser Person arbeiten
Die App sucht, liest oder archiviert mit genau den Berechtigungen dieser Person.
Jederzeit entziehen
Schalten Sie die App ab oder entziehen Sie eine Berechtigung; das gilt ab dem nächsten Aufruf.
System API
Das Backend Ihres Unternehmens
Für Migrationen, Compliance-Abläufe, Berichte und die Systeme, die Ihr Archiv mit Ihrer übrigen IT synchron halten.
Aus, bis Sie es einschalten
Jede Funktion, von der Suche bis zum Löschen, hat einen eigenen Schlüssel und bleibt abgeschaltet, bis ein Administrator ihr Kennwort setzt. Der Schlüssel für eine Funktion öffnet nichts anderes, und ein neues Kennwort setzt das alte sofort außer Kraft.
Zugriff im gesamten Unternehmen
Ein API-Schlüssel der System API gilt für alle Archive in Ihrem Unternehmen, über die Berechtigungen einzelner Benutzer hinaus. Genau das brauchen Migrations- und Compliance-Werkzeuge, und deshalb gehört er in Ihr Backend, niemals in die Hände der Benutzer. Für Personen gibt es die User API.
Löschen, das sich weiter an Ihre Regeln hält
Löschen Sie bis zu tausend Dokumente pro Aufruf, und EMA prüft trotzdem jedes einzelne auf Mindestvorhaltezeit, Legal Holds, nur einmal beschreibbaren Speicher und offene Fälle. Jede Löschung landet im Sicheren Log.
Suchen und herunterladen
Dokumente im gesamten Archiv finden und abrufen, für Prüfungen, E-Discovery und Ihre eigenen Abläufe.
E-Mails und Dateien archivieren
Per API archivierte E-Mails nehmen denselben Weg wie der laufende E-Mail-Verkehr: signiert, indiziert und mit Ihren Mindestvorhaltezeiten. Journalberichte gehen direkt ins Archiv.
Attribute in großem Umfang
Rechnungsnummern, Projekte oder Schlagwörter zu Fällen aus Ihren eigenen Systemen für Tausende Dokumente setzen.
Vertretungen und Domänen
Vertreter, lokale Domänen und Archivierungsregeln mit Ihrem Verzeichnis abgleichen.
Berichte und Auswertungen
Nutzungsberichte jeder Größe und Trefferzahlen für viele Suchen in einem Durchgang.
Gesprächsaufzeichnung
Lassen Sie Ihre Telefonanlage Aufzeichnungen über EMA Voice starten und stoppen.
Zertifikate
Neue Zertifikate aus Ihrer eigenen PKI ausrollen, ohne Umweg über die Weboberfläche.
Sauberes Herunterfahren
Ihre USV kann EMA bei einem Stromausfall sauber herunterfahren.
User API oder System API?
Wischen Sie seitlich, um die ganze Tabelle zu sehen.
| Funktion |
Benutzer-API
Im Namen einer Person
|
System API
Für das Unternehmen
|
|---|---|---|
| Für wen sie arbeitet | ||
| Arbeitet als | Eine angemeldete Person | Ihr Unternehmen |
| Sieht | Was diese Person sehen darf | Alles, was ihre Funktion abdeckt |
| Geeignet für | Apps, Portale, KI-Assistenten | Migrationen, Compliance, Berichte |
| Zugriff | ||
| Anmeldung | OAuth 2.0 mit PKCE | Schlüssel und Kennwort |
| Eingeschaltet | Je App | Je Funktion |
| Entzogen | Ein Klick | Ein neues Kennwort |
| Was sie kann | ||
| Suchen und lesen | ||
| Originale herunterladen | ||
| Dateien und E-Mails archivieren | ||
| Attribute lesen und schreiben | ||
| Dokumente löschen | ||
| Vertretungen, Domänen, Zertifikate | ||
| Berichte und Auswertungen | ||
Für Entwickler
Alles, was Sie brauchen, ist im Lieferumfang
Dokumentation, ein SDK und Beispiele sind in EMA enthalten. Eine Registrierung in einem Portal ist nicht nötig.
.NET SDK
Typisierte Clients für beide APIs, mit eingebauter Anmeldung, Paginierung, Wiederholungslogik und Zertifikats-Pinning. Sie laden es direkt aus Ihrem EMA herunter.
Dokumentation in EMA
Jeder Endpunkt mit Anfragebeispielen in curl und C#, direkt aus der Weboberfläche aufrufbar.
Keine Aufruflimits
Ihre Integration läuft so schnell, wie Ihr Archiv antwortet.
Stabilität zugesagt
Updates innerhalb einer Hauptversion entfernen grundsätzlich kein Feld, ändern keinen Typ und fügen keinen Pflichtparameter hinzu. Was Sie bauen, funktioniert weiter.
Mitsprache vor dem Speichern
Über einen Webhook kann Ihr eigener Dienst Attributänderungen freigeben, ablehnen oder korrigieren, bevor EMA sie speichert.
PowerShell für Importe
Die Mail Import Tools importieren aus Microsoft 365, Exchange, IMAP, PST und mehr, per Skript ganz nach Ihren Vorgaben.
Ein Zertifikat zum Pinnen
API-Aufrufe laufen über einen Port mit eigenem Zertifikat, so weiß Ihre App, dass sie mit Ihrem EMA spricht.
Ereignisse in Vorbereitung
Skripte, die reagieren, sobald ein Dokument archiviert wird, kommen bald.
Fragen zu den APIs
Sind die APIs kostenlos?
Ja. Für die APIs und das SDK fallen keine Kosten an.
Welche EMA-Editionen enthalten sie?
Die User API ist in jeder Edition enthalten. Die System API und das SDK gibt es in jeder Edition ab Business Professional. Die kleinste Edition ist ein kompaktes Archiv für kleine Büros und verzichtet auf die Integrationsfunktionen.
Welche Apps kann ich damit entwickeln?
Alles, was in Ihrem Archiv etwas finden oder ihm etwas hinzufügen soll. Typische Beispiele sind ein Portal, in dem jeder seine eigenen Dokumente sieht, eine Erfassungs- oder Scan-App, ein ERP- oder CRM-System, das archiviert, was es versendet, und Attribute ausfüllt, eine Migration aus einem anderen System, Compliance-Berichte, Löschläufe nach Ihren Mindestvorhaltezeiten und KI-Assistenten. Wir haben EMA Scan Client selbst auf der User API entwickelt.
Was ist der Unterschied zwischen User API und System API?
Die User API arbeitet im Namen einer Person. Eine App meldet sich für jemanden an, und EMA wendet bei jedem Aufruf die Berechtigungen dieser Person an, sodass die App nie mehr sieht als die Person selbst. Die System API arbeitet für Ihr Unternehmen. Aufgaben im Backend wie Migrationen, Berichte und Löschungen greifen auf alle Postfächer zu, Funktion für Funktion, jede mit eigenem Kennwort eingeschaltet. Die Faustregel lautet, dass eine Person vor dem Bildschirm die User API braucht und eine Aufgabe im Hintergrund die System API.
Wie melden sich Apps an?
Apps für die User API melden sich über OAuth 2.0 an. Ein Administrator registriert die App, und jede Person meldet sich einmal mit dem eigenen EMA-Konto an, die App speichert also nie ein Kennwort. Aufrufe der System API nutzen einen API-Schlüssel und ein Kennwort je Funktion. Um eine App auszusperren, deaktiviert ein Administrator ihre Registrierung oder ein Kennwort wird geändert; beides wirkt sofort.
Kann die System API zu viel löschen?
Nein. Sie löscht nur die Dokumente, die Sie über ihre Dokument-IDs angeben, bis zu 1.000 pro Aufruf. Einen Befehl „alles löschen, was älter ist als“ gibt es nicht. Mindestvorhaltezeit, Legal Holds, Löschsperren und WORM-Speicher gelten weiterhin, und jede Löschung wird im Sicheren Log festgehalten.
Gibt es Dokumentation, Beispielcode oder ein Testsystem?
Ja. Die vollständige API-Referenz mit Anfragebeispielen ist in EMA enthalten. Ein .NET SDK mit typisierten Clients übernimmt Anmeldung, Paginierung und Wiederholungslogik. Wenn Sie für die Entwicklung ein Testsystem möchten, können wir eines einrichten.
Können Sie eine App für uns entwickeln?
Individuelle Apps entwickeln wir nicht selbst, unsere Partner aber schon, und wir bringen Sie mit dem passenden in Kontakt. Unser Entwicklersupport hilft allen, die den Code schreiben, ob Ihrem eigenen Team oder einem Partner.
Kann ich eine neue API vorschlagen?
Gern. Sagen Sie uns, was Sie brauchen und wofür. Wenn es zu unserer Produktplanung passt, nehmen wir es auf.
Funktionieren die APIs mit EMA Cloud ebenso wie mit EMA On-Premise?
Ja, und sie funktionieren genau gleich. Eine App, die für die eine Variante geschrieben wurde, läuft ohne Änderungen mit der anderen.
Bleiben die APIs bei EMA-Updates stabil?
Ja. Innerhalb einer Hauptversion entfernen wir keine Fehlercodes und benennen keine um, entfernen keine Antwortfelder, ändern keinen Feldtyp, machen keinen optionalen Parameter zur Pflicht und lehnen keine Werte ab, die wir bisher akzeptiert haben. Neue Felder, Endpunkte und optionale Parameter können hinzukommen, Code, der Unbekanntes ignoriert, funktioniert also weiter. Nur eine Sicherheitslücke oder ein schwerer Fehler könnte eine Ausnahme erzwingen, und dann halten wir die Änderung so klein wie möglich und kündigen sie in den Versionshinweisen an.