Inhaltsverzeichnis
- Einleitung
- Native Integrationen verstehen
- Erstellen einer Integration
- Details des Integrationsformulars
- Erstellen einer Produktintegration
- Nach Erstellung der Integration
- Anzeigen und Verwalten von Integrationen
- Konnektierbare Kontointegrationen
- Community-Abzeichen und Community-Integrationen
- Bewährte Methoden für den Installationsablauf
- Unterstützung bei der Integration
- Schlussfolgerung
Einleitung
Die Integration mit Esadax bietet eine leistungsstarke Möglichkeit, Ihre Anwendung oder Ihren Service zu verbessern. Ganz gleich, ob Sie ein Tool für den internen Gebrauch erstellen oder für andere veröffentlichen: Dieser Leitfaden führt Sie Schritt für Schritt durch die Erstellung, Verwaltung und Optimierung Ihrer Integration und enthält Best Practices, um eine reibungslose Benutzererfahrung zu gewährleisten.
Native Integrationen verstehen
Native Integrationen sind erstklassige Bürger im Esadax-Ökosystem und bieten eine direkte und nahtlose Integration mit Plattformfunktionen.
Die wichtigsten Vorteile:
- Keine Middleware erforderlich — Native Unterstützung innerhalb der Esadax-Plattform.
- Verkürzte Entwicklungszeit – Vorgefertigte Komponenten und vereinfachtes Setup.
- Stärkere Entwicklererfahrung — Vollständige Dokumentation und Plattformunterstützung.
Sie können auch benutzerdefinierte Integrationen erstellen, wenn Ihr Anwendungsfall externe Dienste oder APIs erfordert.
Erstellen einer Integration
Um loszulegen:
- Gehen Sie zur Integrationskonsole.
- Klicken Sie auf Integration erstellen.
- Füllen Sie das Formular mit den grundlegenden Informationen zu Ihrer Integration aus (siehe nächster Abschnitt).
Details zum Integrationsformular
Geben Sie beim Ausfüllen des Integrationsformulars Folgendes an:
- Name: Ein eindeutiger Bezeichner für Ihre Integration.
- Beschreibung: Eine kurze Erklärung, was Ihre Integration macht.
- Integrationstyp: Wählen Sie zwischen „Nativ“ und „Benutzerdefiniert“.
- Sichtbarkeitseinstellungen: Definieren Sie, wer die Integration sehen oder verwenden kann.
- Support-E-Mail: Geben Sie Kontaktdaten für den Support an.
- Dokumentationslink (optional): Helfen Sie den Benutzern zu verstehen, wie sie es installieren und verwenden können.
- Bereitstellungsschaltfläche (optional): Fügen Sie eine Schaltfläche zum automatischen Bereitstellen der Integration aus Git hinzu.
Erstellen einer Produktintegration
Wenn Ihre Integration ein installierbares Produkt umfasst, sollten Sie Folgendes tun:
- Stellen Sie einen übersichtlichen Installationsablauf bereit, der sowohl neuen als auch bestehenden Benutzern gerecht wird.
- Fügen Sie eine prägnante Dokumentation für die Installation und Verwendung hinzu.
- Definieren Sie Standard-Einstellungen, die sofort einsatzbereit sind und gleichzeitig Anpassungen ermöglichen.
- Verwenden Sie Versionierung in Ihrem Formular, um Updates und Abwärtskompatibilität zu verfolgen.
Erstellung nach der Integration
Nach der Veröffentlichung können Sie:
- Überwachen Sie Protokolle mit der Schaltfläche Protokolle anzeigen in der Integrationskonsole.
- Update-Status: Verfolgen Sie Installationsmetriken, Fehler und Versionsänderungen.
- Verfeinern Sie Ihre Integration: Iterieren Sie basierend auf Benutzerfeedback oder Tests.
Anzeigen und Verwalten von Integrationen
In der Integrationskonsole können Sie:
- Zeigen Sie eine Liste Ihrer Integrationen an.
- Greifen Sie auf Details zu, einschließlich Live-URLs, Installationsprotokolle und Sichtbarkeitsstatus.
- Filtern Sie Protokolle nach Anforderungstyp (z. B. Fehler, Installationen).
Verbindbare Konto-Integrationen
Wenn Ihre Integration externe Dienste verbindet (z. B. Analyse, Authentifizierung, E-Commerce):
- Aktivieren Sie sichere Kontoverknüpfung-Workflows.
- Unterstützung von Multi-Account-Szenarien (Einzel- vs. org).
- Validieren Sie Token und Identitäten gemäß dem gemeinsamen Sicherheitsmodell von Esadax.
Community-Badge und Community-Integrationen
- Integrationen, die von externen Entwicklern eingereicht werden, erhalten ein Community-Badge, das sie als von Drittanbietern unterstützt kennzeichnet.
- Diese dürfen mit einem eindeutigen Label im Marktplatz erscheinen.
- Bevor Sie eine Community-Integration installieren, sollten Benutzer die folgenden Informationen des Entwicklers lesen:
- Datenschutzerklärung
- Nutzungsbedingungen
- Details zum Support
Best Practices für den Installationsablauf
Die Gestaltung einer intuitiven Installationserfahrung verbessert die Akzeptanz.
Empfohlene Durchflussmenge:
- Neue Benutzer:
- Führen Sie durch die Kontoerstellung innerhalb des Installationsprozesses.
- Wiederkehrende Benutzer:
- Ermöglichen Sie eine nahtlose Anmeldung, ohne den Installationsfortschritt zu verlieren.
- Wiederherstellung von Fehlern:
- Passwortzurücksetzungen und abgelaufene Sitzungen werden problemlos verarbeitet.
- Standards:
- Konfigurieren Sie sinnvolle Einstellungen, um die erforderliche Eingabe zu minimieren.
- Erweiterte Optionen:
- Stellen Sie sie zur Verfügung, aber verstecken Sie sie hinter einem Toggle oder einem erweiterbaren Abschnitt.
Unterstützung bei der Integration
Sie sind für den laufenden Support Ihrer Integration verantwortlich:
- Reagieren Sie umgehend auf Probleme über Ihre Support-E-Mail.
- Fügen Sie Tipps zur Fehlerbehebung und bekannte Einschränkungen in Ihre Dokumentation ein.
- Erwägen Sie, versionierte Changelogs einzurichten, um Aktualisierungen klar zu kommunizieren.
Schlussfolgerung
Wenn Sie diesen Leitfaden befolgen, können Sie eine zuverlässige und benutzerfreundliche Integration für die Esadax-Plattform bereitstellen. Egal, ob Sie interne Workflows erweitern oder Tools für die Community entwickeln, ein durchdachtes Integrationsdesign – von der Formularstruktur bis zum Benutzerfluss – stellt sicher, dass Ihre Arbeit erfolgreich und skalierbar ist.
