SonoGdt / GDT API Dokumentation

Übersicht

Die SonoGdt / GDT API ermöglicht sichere Datei-Uploads in das Offisy-System. Diese API wurde speziell für die Integration mit GDT- und SonoGdt-Systemen entwickelt, um medizinische Dateien wie Untersuchungsergebnisse, Berichte und andere Dokumente hochzuladen.

Endpunkt: Datei-Upload

URL

POST https://my.offisy.at/api/gdt/upload
oder
POST https://my.offisy.at/api/sonogdt/upload

Beschreibung

Dieser Endpunkt ermöglicht das Hochladen medizinischer Dateien in das Offisy-System. Die Dateien werden einem bestimmten Unternehmen (Arzt) und einem Kunden (Patienten) zugeordnet. Es können sowohl die URL-Präfixe gdt als auch sonogdt verwendet werden.

Authentifizierung

Die Authentifizierung erfolgt über HTTP-Header. Folgende Header sind erforderlich (entweder mit dem Präfix x-gdt- oder x-sonogdt-):

Header	Typ	Beschreibung
x-gdt-company / x-sonogdt-company	UUID	Die UUID des Unternehmens im Offisy-System
x-gdt-customer / x-sonogdt-customer	Integer	Die Kunden-ID im Offisy-System. Verwende Feld 3000 aus der export.gdt
x-gdt-secret / x-sonogdt-secret	String	Geheimer Schlüssel zur Authentifizierung. Wird in den Medizinischen Einstellungen automatisch generiert.

Anfrageparameter

Header

• x-gdt-company oder x-sonogdt-company: (Erforderlich) UUID-Format, z. B. aaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
• x-gdt-customer oder x-sonogdt-customer: (Erforderlich) Ganzzahliger Wert, z. B. 1234
• x-gdt-secret oder x-sonogdt-secret: (Erforderlich) Geheimer Schlüssel, z. B. the.unique.secret. Wird in den Medizinischen Einstellungen automatisch generiert.
• Content-Type: multipart/form-data

Formular Daten

• file: (Erforderlich) Die hochzuladende Datei. Dies sollte ein gültiges Dateiformat sein (z. B. PDF, Bild) und darf die maximale Dateigröße nicht überschreiten. Es ist erlaubt, mehrere Dateien in einer einzigen Anfrage hochzuladen, aber jede Datei muss unter dem Größenlimit liegen.

Alle gültigen Dateien werden im Offisy-System unter dem angegebenen Unternehmen und Kunden gespeichert.

Einschränkungen

• Maximale Dateigröße: 15 MB
• Das Unternehmen muss über ausreichend freien Speicherplatz verfügen
• Der Kunde muss existieren und dem angegebenen Unternehmen angehören

Beispielanfrage

curl --request POST \
  --url https://my.offisy.at/api/gdt/upload \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-gdt-company: aaaaa-bbbb-cccc-dddd-eeeeeeeeeeee' \
  --header 'x-gdt-customer: 1234' \
  --header 'x-gdt-secret: the.unique.secret' \
  --form file=@/path/to/your/file.pdf

Antwort

Erfolgreiche Antwort (Code 200)

{
  "status": "success"
}

Fehlermeldungen (Code 400)

1. Ungültige oder fehlende Unternehmens-UUID

{
  "status": "error",
  "message": "UUID forbidden: [invalid-uuid]"
}

2. Ungültiges Secret

{
  "status": "error",
  "message": "Secret not valid."
}

3. Kunde nicht gefunden

{
  "status": "error",
  "message": "Customer not found: [customer-id]"
}

4. Kunde gehört zu einem anderen Unternehmen

{
  "status": "error",
  "message": "Der Kunde gehört nicht zu diesem Account."
}

5. Keine Datei gefunden

{
  "status": "error",
  "message": "Keine Datei gefunden."
}

6. Datei zu groß

{
  "status": "error",
  "message": "Die Datei ist zu groß. (Maximal 15 MB sind erlaubt)"
}

7. Unzureichender Speicherplatz

{
  "status": "error",
  "message": "Unzureichender freier Speicherplatz."
}

Verwendung in Postman

So verwendest du diese API in Postman:

1. Erstelle eine neue Anfrage mit der Methode POST.
2. Gib die URL ein: https://my.offisy.at/api/gdt/upload (oder https://my.offisy.at/api/sonogdt/upload)
3. Füge im Tab "Headers" hinzu:
   • x-gdt-company: aaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
   • x-gdt-customer: 1234
   • x-gdt-secret: the.unique.secret (Alternativ können die Header auch mit x-sonogdt- beginnen)
4. Wähle im Tab "Body" "form-data" aus und füge einen Schlüssel namens "file" mit dem Typ "File" hinzu.
5. Klicke auf "Select Files" und wähle die Datei aus, die du hochladen möchtest.
6. Klicke auf "Send", um die Anfrage abzusenden.

(Hinweis: Den geheimen Schlüssel x-gdt-secret generierst du in den Medizinischen Einstellungen.)