Technische Grundlagen der Varyos API-Plattform
Für Entwicklung und Architektur

Technische Grundlagen der Varyos API-Plattform

Die öffentliche Schnittstelle wird über Azure API Management bereitgestellt. Endpunkte, Authentifizierung und Berechtigungen richten sich nach dem vereinbarten Anwendungsfall.

Integrationen greifen auf freigegebene Funktionen zu und müssen Mandantenzuordnung, Geschäftsregeln und Fehlerbehandlung berücksichtigen.

API-Referenz öffnen Technische Frage stellen
Azure API Management Endpunktbezogene Authentifizierung Mandantenbezogener Zugriff
CLIENT Anwendung oder Partnerdienst
APIM Schlüssel und Richtlinien
API Identität und Berechtigung
VARYOS Fachliche Verarbeitung
Request
Prüfung
Workflow
Zugriff

Mehrere Prüfungen schützen die Schnittstelle

Die verbindlichen Anforderungen stehen bei der jeweiligen API im Developer Portal.

APIM-Abonnement

Für geschützte APIs wird der bereitgestellte Subscription Key im vorgesehenen Request-Header übertragen.

Identität

Wo ein Benutzer- oder Dienstkontext erforderlich ist, wird zusätzlich ein gültiges Bearer-Token geprüft.

Mandant und Rolle

Die Anwendung darf ausschließlich im freigegebenen Mandanten und innerhalb ihrer Berechtigungen arbeiten.

Integrationsmuster

Aufruf und Ereignis unterscheiden

API-Aufruf

  • Der Client startet eine unterstützte Operation
  • APIM und Anwendung prüfen Zugang und Kontext
  • Varyos führt die fachliche Verarbeitung aus
  • Der Client wertet Status und Fehlerantwort aus

Ausgehender Webhook

  • Ein vereinbartes Ereignis löst die Zustellung aus
  • Zeitstempel und Signatur sichern die Nachricht
  • Der Empfänger verarbeitet wiederholte Zustellungen idempotent
  • Fehlversuche werden nachvollziehbar protokolliert

Datenübernahme

  • Quellformat und Datenqualität zuerst prüfen
  • Schlüssel und Referenzen eindeutig zuordnen
  • Mit einer begrenzten Datenmenge testen
  • Import und Ergebnis protokollieren
Fehlerbehandlung

Wiederholungen und Dubletten einplanen

Netzwerkaufrufe können fehlschlagen oder mehrfach zugestellt werden. Die Integration muss diesen Fall ohne doppelte Fachvorgänge verarbeiten.

Temporäre Fehler

Nur geeignete Aufrufe mit begrenzter Wartezeit und Backoff wiederholen. Rate-Limits und Retry-Hinweise beachten.

Dauerhafte Fehler

Validierungs- und Berechtigungsfehler protokollieren, fachlich zuordnen und vor einem neuen Versuch korrigieren.

Dokumentation und Abstimmung

Mit einem abgegrenzten Anwendungsfall starten

Die API-Dokumentation beschreibt die freigegebenen Operationen. Projektspezifische Fragen klären wir vor der Umsetzung.

API-Referenz Customizing Zusammenarbeit Kontakt
Leider ist ein Fehler aufgetreten. Laden Sie die Seite neu. 2026.09.18 Neu laden 🗙