Darstellung
Glossar
Begriffe, die in der Dokumentation immer wieder vorkommen.
Authentifizierung
| Begriff | Bedeutung |
|---|---|
| HMAC | Verfahren, mit dem ein Request mithilfe eines geheimen Schlüssels signiert wird. Die API erkennt so, dass der Request von dir stammt und nicht verändert wurde. |
hmac_ID | 22-stellige numerische Kennung deines Schlüsselsatzes. Sie wird bei jedem Request mitgesendet und ist nicht geheim. |
secret_key | Geheimer Schlüssel für die Signatur (HMAC-SHA256). Behandle ihn wie ein Passwort. |
encryption_key | Geheimer Schlüssel für die AES-256-CBC-Verschlüsselung der Nachricht (message). Behandle ihn wie ein Passwort. |
| Umschlag | Die drei Felder hmac_ID, message und hmac, in die jeder Request verpackt wird. |
hmac_unique | Einmalige ID pro Request. Verhindert, dass abgefangene Requests erneut abgespielt werden (Replay-Schutz). |
| Origin | Absender-Domain deiner Anwendung im HTTP-Header Origin. Muss bei eBOnaut freigegeben sein. |
| Partner-HMAC | Schlüsselsatz, den eBOnaut dir ausstellt. Nur für das Pairing. |
| Kunden-HMAC | Schlüsselsatz, der beim Pairing für eine einzelne Kund:in erzeugt wird. Für alle übrigen Endpunkte. |
| Pairing / Codesetup | Ablauf, mit dem eine Kund:in deine Anwendung freigibt, siehe Pairing-Ablauf. |
Fachbegriffe
| Begriff | Bedeutung |
|---|---|
| eBO | Das elektronische Bürger- und Organisationenpostfach, ein Kanal der Justizkommunikation. Über eBOnaut sendest und empfängst du Nachrichten über diesen Kanal. |
| Postbox | Das Postfach einer Kund:in in eBOnaut mit eingehenden, ausgehenden und archivierten Nachrichten. |
| Postboxitem | Eine einzelne Nachricht in der Postbox, inklusive Betreff, Empfänger:in, Absender:in, Status und Dateien. |
| Status | Zustand eines Postboxitems, z. B. draft (Entwurf), inbound (eingegangen), outbound (ausgegangen), outbound_sending, outbound_failed, trash, archive. |
| Empfangsbestätigung | Rückmeldung der Empfänger:in, dass die Nachricht angekommen ist. Wird beim Anlegen über include_read_receipt angefordert. |
| Zertifikat | Elektronisches Zertifikat der Kund:in, mit dem Nachrichten gesendet und empfangen werden. |
| Safe-ID / Justiz-ID | Eindeutige Adresse eines Postfachs im Justiz-Verzeichnis, z. B. DE.Justiz.004804f3-…. Sie dient als Empfängeradresse. |
| Kontakt | Eintrag im Adressbuch der Kund:in mit Name, Anschrift und Justiz-ID. |
| Datahandler | Zwischenspeicher für Ergebnisse von Aufgaben, die im Hintergrund laufen. Du erhältst eine datahandler_ID und holst das Ergebnis einmalig mit datahandler/get ab. |
| Auto-Sync | Automatischer Abgleich eines Zertifikats mit dem Postfach. Lässt sich pro Zertifikat ein- und ausschalten. |
| Tarif | Vertragsumfang der Kund:in. Er legt z. B. die maximale Anzahl hinterlegter Zertifikate fest (certificate limit reached). |
Technik
| Begriff | Bedeutung |
|---|---|
| Typesense | Suchmaschine hinter der Postbox- und Kontaktsuche. Wirkt sich auf die Syntax des Parameters search aus. |
| Polling | Wiederholtes Abfragen, bis ein Ergebnis vorliegt, z. B. bei codesetup/get oder datahandler/get. |
| Replay-Schutz | Schutz davor, dass ein abgefangener Request erneut gesendet wird. Siehe hmac_unique und Zeitstempel. |
| NTP | Dienst zur Zeitsynchronisation. Dein Server muss damit auf die Sekunde genau laufen, weil Requests nur 5 Minuten gültig sind. |
| Rate Limit | Obergrenze von 250 Requests pro Sekunde und IP-Adresse. |