Dokumentation

Erfahren Sie, wie Sie Ihre Integrationspartner verwalten, Spezifikationen definieren und Ihren Onboarding-Workflow mit MyIntegrationHub optimieren.

Kernkonzepte

MyIntegrationHub organisiert Ihre Integrationslandschaft durch eine klare Hierarchie von Objekten. Das Verständnis dieser Kernkonzepte hilft Ihnen, Ihr Partner-Onboarding effizient zu strukturieren.

Workspace

Ein Workspace ist Ihre oberste Organisationseinheit. Er repräsentiert ein Projekt, eine Abteilung oder eine Kundenumgebung. Alle Partner, Integrationen und Spezifikationen befinden sich innerhalb eines Workspaces.

Partner

Ein Partner repräsentiert eine externe Einheit, mit der Sie Daten austauschen — ein Kunde, Lieferant, Logistikdienstleister oder ein anderer Dritter. Partner haben Kontaktdaten, Statusverfolgung und zugehörige Integrationen.

Integration

Eine Integration definiert, wie Daten zwischen Ihnen und einem Partner fließen — Richtung (eingehend/ausgehend), Protokolltyp (REST API, EDI, XML, etc.), Endpunkt-URL und aktueller Status.

Spezifikation

Eine Spezifikation beschreibt das Datenformat für eine Integration — Felddefinitionen, Typen, Verschachtelung, Validierungsregeln und Beispiel-Payloads. Spezifikationen haben Versionen und durchlaufen Freigabe-Workflows.

Freigabe

Freigaben verfolgen Abnahmeprozesse für Spezifikationsänderungen, Integrationsupdates oder Go-live-Entscheidungen. Weisen Sie Reviewer zu, setzen Sie Fristen und verfolgen Sie den Status durch Ausstehend → In Prüfung → Freigegeben.

Checkliste

Checklisten stellen sicher, dass beim Onboarding nichts vergessen wird. Erstellen Sie wiederverwendbare Vorlagen mit kategorisierten Elementen und verfolgen Sie die Fertigstellung pro Partner für einen strukturierten Go-live-Prozess.

Checklisten-Vorlage

Checklisten-Vorlagen sind wiederverwendbare Blaupausen für Onboarding-Prozesse. Definieren Sie einmalig kategorisierte Elemente mit Pflichtmarkierungen und wenden Sie die Vorlage einheitlich auf jeden neuen Partner an.

Testfall

Testfälle validieren Ihre Integrationen anhand ihrer Spezifikationen. Sie können aus Payload-Feldern, Validierungsregeln oder Beispiel-Payloads abgeleitet werden und decken Positiv-, Negativ-, Grenzwert- und Prozessszenarien ab.

Dokument

Speichern und teilen Sie Dateien zu Ihren Integrationen — technische Dokumentation, Mapping-Tabellen, Testberichte oder jede für Ihr Partner-Onboarding relevante Datei.

Kommentar

Fügen Sie kontextbezogene Kommentare zu Spezifikationen, Freigaben oder anderen Objekten hinzu. Kommentare erstellen einen Audit-Trail und erleichtern die Kommunikation zwischen Teammitgliedern und Partnern.

Wie Objekte zusammenhängen

Die Objekte in MyIntegrationHub bilden eine klare Hierarchie. Das Verständnis ihrer Beziehungen hilft Ihnen, Ihre Integrationslandschaft effizient zu organisieren.

WorkspaceÜbergeordneter Container
enthält mehrere
PartnerExterne Einheiten
haben mehrere
IntegrationenDatenflussdefinitionen
SpezifikationenDatenformatdetails
verknüpft & verwaltet durch
FreigabenFreigabeprozess
ChecklisteOnboarding-Aufgaben
DokumentAngehängte Dateien
Checklisten-VorlageWiederverwendbare Vorlagen
TestfallIntegrationsvalidierung

Wichtige Beziehungen

🏢Ein Workspace enthält mehrere Partner, die jeweils eine externe Einheit repräsentieren.
🤝Ein Partner kann mehrere Integrationen haben (eingehende & ausgehende Datenflüsse).
🔗Eine Integration kann mit Spezifikationen verknüpft werden, die das Datenformat beschreiben.
📋Spezifikationen haben Versionen, Validierungsregeln, Payload-Struktur und Beispiel-Payloads.
Änderungen können über Freigaben zur Prüfung und Abnahme eingereicht werden.
📝Checklisten helfen dabei, Onboarding-Meilensteine pro Partner zu verfolgen.
📑Checklisten-Vorlagen bieten wiederverwendbare Blaupausen, die auf jedes neue Partner-Onboarding angewendet werden können.
🧪Testfälle werden aus Spezifikationen und Payloads abgeleitet, um Integrationen vor dem Go-live zu validieren.

In Aktion sehen

Erkunden Sie die Partneransicht unten. Klicken Sie auf einen Partner, um zu sehen, wie Integrationen, Spezifikationen und Freigaben im Partnerkontext organisiert sind.

Partnerübersicht

Partner

3 Partner
NameTypStatusKontaktIntegrationen
Acme CorpCustomerActiveJohn Miller3
GlobalTrade LtdSupplierOnboardingSarah Chen1
TechFlow GmbHLogisticsActiveMax Weber2

↑ Klicken Sie auf einen Partner für die Detailansicht

Typischer Workflow

Folgen Sie diesem schrittweisen Workflow, um einen neuen Partner einzubinden und Ihre Integration vollständig zu dokumentieren. Jeder Schritt baut auf dem vorherigen auf.

Typischer Workflow
Fortschritt: 3 / 7 Schritte abgeschlossen

↑ Klicken Sie auf jeden Schritt, um den Workflow voranzubringen

Go-Live-Checkliste
Acme Corp — Go-Live-Checkliste
3/6

↑ Klicken Sie auf Elemente, um den Status umzuschalten

Workflow-Details

Step 1
Partner erstellen

Navigieren Sie zu Partner in der Seitenleiste und klicken Sie auf + Neuer Partner. Geben Sie den Partnernamen, den Typ (Kunde, Lieferant, Logistik, etc.), Kontaktinformationen und relevante Notizen ein.

Step 2
Integration definieren

Gehen Sie zu Integrationen und erstellen Sie eine neue Integration. Geben Sie den Partnernamen, die Richtung (Eingehend oder Ausgehend), den Typ (REST API, EDI, XML, CSV, etc.), die Endpunkt-URL und einen Anfangsstatus an.

Step 3
Spezifikation erstellen

Erstellen Sie unter Spezifikationen eine neue Spezifikation und verknüpfen Sie sie mit der Integration. Legen Sie den Formattyp, die initiale Versionsnummer fest und geben Sie eine Beschreibung des Datenvertrags an.

Step 4–6
Spezifikation anreichern

Öffnen Sie die Spezifikationsdetailseite und arbeiten Sie die Tabs durch: Payload-Struktur zur Definition von Feldern und deren Typen, Validierungsregeln für Geschäftsregeln und Beispiel-Payload mit einem realitätsnahen Beispiel.

Step 7
Freigabe & Version beantragen

Erstellen Sie eine Freigabe, um die Spezifikation zur Prüfung einzureichen. Nach der Freigabe nutzen Sie den Tab Versionshistorie, um einen Versions-Snapshot zu erstellen. Dies bewahrt den freigegebenen Zustand und ermöglicht die Nachverfolgung zukünftiger Änderungen.

Beispiele

Erkunden Sie diese praxisnahen Beispiele, um zu verstehen, wie verschiedene Integrationstypen in MyIntegrationHub dokumentiert werden.

REST-JSON-Bestell-Spezifikation

Dieses Beispiel zeigt eine vollständige JSON-basierte Bestellspezifikation mit Payload-Struktur, Validierungsregeln und einem Beispiel-Payload. Klicken Sie durch die Tabs, um jeden Bereich zu erkunden.

Spezifikationsdetail — REST Order Payload v1.0

REST Order Payload

In Reviewv1.0
Format
JSON
Felder
10
Erforderlich
9
Regeln
7
Name
REST Order Payload
Partner
Acme Corp
Typ
JSON
Version
1.0
Status
In Review
Integration
Invoice Export API
Beschreibung

JSON payload specification for outbound order data via REST API. Includes customer information, order items with SKU/quantity/price, and total calculation.

↑ Klicken Sie durch die Tabs, um die Spezifikationsansichten zu erkunden

EDI 850 Bestellung

EDI-Integrationen folgen derselben Struktur. Unten sehen Sie ein Beispiel, wie eine EDI-Spezifikation im System aussieht.

EDI 850 Purchase Order — v2.1

EDI 850 Purchase Order

Approvedv2.1
Format
EDI
Partner
Acme Corp
Felder
24
Regeln
8
Beispiel-EDI-Segmente
ISA*00*          *00*          *ZZ*ACME           *ZZ*PARTNER        *250320*1200*U*00401*000000001*0*P*>~
GS*PO*ACME*PARTNER*20250320*1200*1*X*004010~
ST*850*0001~
BEG*00*NE*ORD-2025-001**20250320~
N1*BY*Acme Corp*92*ACME001~
PO1*1*10*EA*29.99**VP*WIDGET-001~
CTT*1~
SE*7*0001~

XML-Versandanzeige (ASN)

XML-basierte Spezifikationen unterstützen verschachtelte Strukturen. Das System erkennt das Format automatisch und validiert die Syntax.

ASN XML Schema — v1.2

ASN XML Schema

Draftv1.2
✓ Gültiges XMLFormat: XML (automatisch erkannt)
<?xml version="1.0" encoding="UTF-8"?>
<ShippingNotice>
  <Header>
    <NoticeID>ASN-2025-042</NoticeID>
    <ShipDate>2025-03-20</ShipDate>
    <Carrier>DHL Express</Carrier>
  </Header>
  <Shipment>
    <TrackingNumber>1Z999AA10123456784</TrackingNumber>
    <Origin>
      <City>Hamburg</City>
      <Country>DE</Country>
    </Origin>
    <Destination>
      <City>New York</City>
      <Country>US</Country>
    </Destination>
  </Shipment>
  <Items>
    <Item sku="WIDGET-001" quantity="10" />
    <Item sku="GADGET-002" quantity="5" />
  </Items>
</ShippingNotice>

Spezifikationsänderungs-Freigabe

Wenn Spezifikationsänderungen eine Abnahme benötigen, erstellen Sie eine Freigabe. So sieht der Freigabe-Workflow aus:

Freigaben — EDI 850 v2.1 Release

EDI 850 v2.1 Release

Approved
Partner
Acme Corp
Typ
Specification Change
Reviewer
Sarah Chen
Fälligkeitsdatum
2025-03-15
Sarah Chen freigegeben am 2025-03-14
💬Sarah Chen: "Looks good, all field mappings verified."

Checklisten-Vorlage

Erstellen Sie wiederverwendbare Vorlagen mit kategorisierten Elementen und Pflichtmarkierungen. Wenden Sie sie auf jeden neuen Partner für einen einheitlichen Onboarding-Prozess an.

Checklisten-Vorlage — API-Integration-Setup
Checklisten-Vorlage — API-Integration-Setup
8 Items
#TitelKategorieErforderlich
1API credentials provisionedSetup
2Endpoint URL configuredSetup
3Authentication method verifiedTechnical
4Payload structure definedTechnical
5Validation rules documentedDocumentation
6Sample payload testedTesting
7Error handling verifiedTesting
8Go-live approval obtainedApproval

Testfälle aus der Spezifikation

Testfälle können aus Ihren Spezifikationsfeldern, Validierungsregeln und Beispiel-Payloads abgeleitet werden. Jeder Testfall überprüft einen bestimmten Aspekt der Integration.

Testfälle — REST Order Payload
Testfälle — REST Order Payload
6 Test Cases
Positive
1
Negative
2
Boundary
2
Process
1
CodeTitelTesttypQuelleStatus
TC-001Valid order payload acceptedpositivesample_payloadready
TC-002Missing required field order_id rejectednegativepayload_fieldready
TC-003Invalid email format rejectednegativevalidation_ruledraft
TC-004Empty items array rejectedboundaryvalidation_ruleready
TC-005Quantity zero rejectedboundaryvalidation_ruledraft
TC-006Total amount equals sum of itemsprocessvalidation_rulereviewed

↑ Click on a test case to see its details

FAQ & Best Practices

Häufige Fragen und Empfehlungen, um das Beste aus MyIntegrationHub herauszuholen.

Bereit loszulegen?

Erstellen Sie Ihr kostenloses Konto und beginnen Sie noch heute mit der Verwaltung Ihrer Integrationspartner.