Wenn Sie eine App erstellen, die mit Omnisend verbunden ist, folgen Sie den folgenden Schritten, um die API zu verstehen, eine Authentifizierungsmethode auszuwählen, Ihre Integration abzuschließen und sie zur Überprüfung einzureichen.
🔋 Dieser Artikel konzentriert sich auf die Partnerreise.Für Implementierungsdetails verwenden Sie die Omnisend API-Dokumentation.
Bevor Sie beginnen
Definieren Sie, was Ihre App mit Omnisend-Daten tun wird.Zum Beispiel könnte Ihre App:
Kontakte synchronisieren.
Produkte abrufen.
Ereignisse senden, die Automatisierungs-Workflows auslösen.
Omnisend ist eine Self-Service-Plattform.Sie müssen kein separates Sandbox-Konto für die Entwicklung oder das Testen anfordern.
Erstellen Sie ein reguläres Omnisend-Konto und verwenden Sie Testdaten, während Sie Ihre Integration entwickeln.Sie können ein Konto über den Standard-Anmeldeprozess von Omnisend erstellen.
Einreichungsprozess
Schritt 1. Überprüfen Sie die Omnisend API-Dokumentation.
Beginnen Sie mit Erstellen Sie Ihre eigene App.Dieser Leitfaden erklärt, wie Omnisend-Apps strukturiert sind und welche Schritte erforderlich sind.
Überprüfen Sie als Nächstes den Schnellstartleitfaden.Er behandelt die API-Grundlagen, die Sie für die Entwicklung benötigen, einschließlich Authentifizierung, Endpunkte und Anforderungsformate.
Identifizieren Sie die API-Ressourcen, die Ihre App benötigt:
Verwenden Sie die Kontakte-API, wenn Ihre App Kontaktdaten synchronisiert.
Verwenden Sie die Ereignis-API, wenn Ihre App Ereignisse sendet oder Automatisierungs-Workflows auslöst.
Verwenden Sie die Dokumentation zur Ereignisverfolgung, wenn Ihre Integration Daten zum Website-Verhalten benötigt, wie z. B. Seitenaufrufe, Produktansichten oder Warenkorbabgaben.
Bevor Sie fortfahren, dokumentieren Sie:
Was Ihre App an Omnisend senden wird.
Was Ihre App abrufen wird.
Welche Berechtigungen sie benötigt.
Was passieren sollte, wenn eine Anfrage fehlschlägt.
Schritt 2. Wählen Sie eine Authentifizierungsmethode
Wählen Sie zwischen einem API-Schlüssel und OAuth, je nachdem, wie Benutzer Ihre App verbinden werden.
🔋 Für eine öffentliche App, mit der mehrere Händler verbinden werden, empfiehlt Omnisend OAuth.OAuth bietet jedem Benutzer einen Autorisierungsfluss, anstatt dass sie einen API-Schlüssel manuell erstellen und teilen müssen.
Um OAuth zu implementieren, folgen Sie den OAuth-Authentifizierungsanweisungen.Reichen Sie dann das Antragsformular für OAuth-Anmeldeinformationen ein.
Geben Sie die im Formular angeforderten Informationen an.Omnisend wird die Anmeldeinformationen und Informationen bereitstellen, die Sie benötigen, um fortzufahren.
Schritt 3. Bauen und testen Sie Ihre Integration
Bauen und testen Sie Ihre Integration mit einem regulären Omnisend-Konto.Verwenden Sie Testdaten und überprüfen Sie die Ergebnisse in Webshop-Einstellungen → API-Protokolle.Verwenden Sie API-Protokolle, um Anfragen zu debuggen und zu bestätigen, dass Daten korrekt übermittelt werden.
Testen Sie die gesamte Benutzererfahrung, einschließlich:
Autorisierung.
Daten-Synchronisation.
Fehlgeschlagene Anfragen.
Trennen.
Wiederverbinden.
Wenn Ihre App Kontakte, Bestellungen, Produkte, Warenkörbe oder Ereignisse sendet, überprüfen Sie, ob jede Ressource sich wie in Ihrem App-Markt-Eintrag beschrieben verhält.
Schritt 4. Reichen Sie Ihre abgeschlossene App ein.
Nachdem Sie Ihre Integration implementiert und getestet haben, füllen Sie das Antragsformular für den App-Markt aus.
Fügen Sie die im Formular angeforderten Informationen hinzu, wie z. B.:
App-Name.
App-Beschreibung.
Kategorie.
Website.
Logo.
Einrichtungsanweisungen.
Support-Kontakt.
Authentifizierungsmethode.
Angeforderte Berechtigungen.
Testinformationen.
Wenn das Formular Screenshots, Testanmeldeinformationen, Datenschutzinformationen oder Sicherheitsdetails anfordert, fügen Sie diese mit Ihrer Einreichung bei.Dies hilft Omnisend, Ihre App zu testen.
Schritt 5. Verstehen Sie den Überprüfungsprozess
Nachdem Sie das Formular eingereicht haben, überprüft Omnisend Ihre Integration und den vorgeschlagenen App-Marktplatz-Eintrag.
Die Überprüfung prüft, ob:
Die App funktioniert wie beschrieben.
Die App die angeforderten Berechtigungen angemessen nutzt.
Der Eintrag klare Einrichtungsanweisungen bietet.
Omnisend kann Sie kontaktieren, wenn Informationen fehlen oder wenn Ihre Integration Änderungen erfordert.
Wenn Änderungen angefordert werden, aktualisieren Sie die App oder den Eintrag gemäß den Anweisungen des Überprüfungsteams.
Nachdem die Integration die Überprüfung bestanden hat:
Omnisend kann den Eintrag im App-Marktplatz genehmigen und veröffentlichen.Benutzer können dann den Eintrag durchsuchen und die App verbinden.
Omnisend schreibt auch einen speziellen Supportartikel, der erklärt, wie Händler Ihre App mit Omnisend integrieren können.
Schritt 6. Pflegen Sie Ihre App nach der Veröffentlichung
Halten Sie Ihre Integration nach der Veröffentlichung auf dem neuesten Stand.Überprüfen Sie Ihre Berechtigungen, bevor Sie größere Änderungen veröffentlichen, und halten Sie Ihre Kontaktdaten aktuell.
Wenn Sie planen, die Integration zu verbessern, lassen Sie es Omnisend wissen, damit der zugehörige Supportinhalt aktualisiert werden kann.
Häufig gestellte Fragen
Sollte ich einen API-Schlüssel oder OAuth verwenden?
Wählen Sie die Authentifizierungsmethode basierend darauf, wie Benutzer Ihre App verbinden werden.OAuth wird für öffentliche Apps empfohlen, die mehrere Benutzer verwenden werden.
Welche Informationen sollte ich in meiner App-Marktplatz-Einreichung angeben?
Geben Sie die im Einreichungsformular angeforderten Informationen an, einschließlich Ihres App-Namens, der Beschreibung, der Kategorie, der Website, des Logos, der Einrichtungsanweisungen, der Kontaktdaten für den Support, der Authentifizierungsmethode, der angeforderten Berechtigungen und der Testinformationen.
Benötigen Sie Hilfe mit Omnisend? Kontaktieren Sie unser Support-Team über den In-App-Chat oder per E-Mail[email protected]. Unser Team ist 24/7 verfügbar.