bimetricsEntwickler
Belegpostfach

Seite eines Anhangs ansehen

Als Markdown ansehen

Benötigte Berechtigung:inbox:read(Postfach lesen)

Echte Wirkung

Dieser Aufruf ist nicht als rein lesend gekennzeichnet und kann echte Daten in der Firma anlegen oder ändern. Es gibt keine Testumgebung.
get/api/email/inbox/item/{id}/attachment/{aid}/preview

Kein Testversand aus der Dokumentation: Dieser Aufruf ist nicht als rein lesend gekennzeichnet. Nutze das Codebeispiel.

Liefert eine Seite eines Anhangs als Bild (Base64), wie die Vorschau im Postfach, nur für Anhänge mit valid = true, sonst 409 InboxAttachmentNotImportable. pageCount nennt die Seiten; eine Seite dahinter kommt ohne pages. Der erste Aufruf rendert die Datei und kann einige Sekunden dauern.

Benötigt einen Schlüssel mit der Berechtigung inbox:read.

Authentifizierung

headerAuthentifizierungBearer <bm_…>

Empfohlen: Authorization: Bearer bm_…. Der Schlüssel wird nur einmal angezeigt; nie in URLs, Logs oder Frontend-Code ablegen.

Pfadparameter

id*string

ID der Mail (UUID).

Formatuuid
aid*string

ID eines Anhangs dieser Mail (UUID).

Query-Parameter

page?integer

Seite, ab 1; ohne Angabe 1.

Antworten

Erfolg.

application/json
  1. response

Eine Seite eines Anhangs.

ok?boolean

Die Datei ließ sich darstellen.

page?integer

Angefragte Seite.

pageCount?integer

Seiten insgesamt.

pages?array<>|

Die angefragte Seite.

Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/email/inbox/item/497f6eca-6276-4993-bfeb-53cbbbba6f08/attachment/string/preview" \  -H "Authorization: Bearer $BIMETRICS_API_KEY"
Beispielantwort
{  "ok": true,  "page": 1,  "pageCount": 2,  "pages": [    {      "content": "iVBORw0KGgo=",      "mime": "image/png"    }  ]}