Referenz
Die auf dieser Seite zusammengetragenen Informationen sind für die Entwicklung Ihrer App und die Nutzung der hier zur Verfügung gestellten Leitfäden von zentraler Bedeutung.

App-Status

Alle Apps in Yext verfügen über einen App-Directory-Status: Privat, Eingereicht oder Veröffentlicht.
  • Privat
    • Der Standard-Status, wenn eine App erstellt wird. Die App ist privat und kann nicht im App Directory angezeigt werden.
    • Eine App kann im privaten Modus entwickelt werden. Zugriffstokens können ohne Einschränkung über das OAuth-Verfahren angefordert werden.
    • Mögliche Status-Änderungen:
      • App-Entwickler reicht die App in das App Directory ein → Eingereicht
  • Übermittelt
    • Die App wurde vom App-Entwickler an das App Directory von Yext übermittelt.
    • Yext prüft die App und entscheidet, ob die App veröffentlicht, abgelehnt oder der Entwickler bezüglich bestimmter Fragen zur App kontaktiert werden soll.
    • Mögliche Status-Änderungen:
      • App-Entwickler zieht seine Einreichung für das App Directory zurück → Privat
      • Yext genehmigt die App → Veröffentlicht
      • Yext lehnt die App ab → Privat
  • Veröffentlicht
    • Die App wurde im App Directory veröffentlicht. Yext wird daraufhin den Entwickler bzgl. dieser Statusänderung kontaktieren. Die App wird im App Directory angezeigt, von wo aus Kunden sie installieren können.
    • Falls Yext zu irgendeinem Zeitpunkt feststellen sollte, dass die App gegen die Nutzungsbedingungen oder Richtlinien des App Directory verstößt, oder die App fehlerhaft ist und Probleme auf der Yext-Plattform bzw. für die Kunden von Yext verursacht, wird Yext die App widerrufen. Yext wird den App-Entwickler kontaktieren, damit die festgestellten Probleme behoben werden können.
    • Mögliche Status-Änderungen:
      • App-Entwickler zieht Veröffentlichung im App Directory zurück → Privat
      • Yext widerruft die App → Privat
Nach oben

App-Konfiguration

Wenn Sie eine App in der Entwicklerkonsole erstellen, müssen Sie Werte für die folgenden Felder angeben:
  • App-Name
    • Der Name Ihrer App, so wie er im App Directory angezeigt werden wird.
    • Eine E-Mail-Adresse, an die Kunden Fragen, Kommentare und Support-Anfragen senden können.
  • Kontakt-E-Mail-Adresse
    • Gültige E-Mail-Adresse
    • Eine E-Mail-Adresse des App-Entwicklers, die von Yext im Rahmen der App-Einreichung genutzt wird oder falls wir Fragen oder Bedenken bzgl. Ihrer App haben.
    • Diese E-Mail-Adresse wird bei Aufnahme Ihrer App in das App Directory nicht öffentlich aufgeführt werden.
  • Telefonnummer des Ansprechpartners
    • Gültige Telefonnummer
    • Eine Telefonnummer des App-Entwicklers, die von Yext im Rahmen der App-Einreichung genutzt wird oder falls wir Fragen oder Bedenken bzgl. Ihrer App haben.
    • Diese Telefonnummer wird bei Aufnahme Ihrer App in das App Directory nicht öffentlich aufgeführt werden.
  • Berechtigungen
    • Das Berechtigungslevel, das Ihre App benötigt (entweder „schreibgeschützt“ oder „Lesen/Schreiben“). Diese Einstellung gilt für sämtliche Endpunkte, die Sie für Ihre App ausgewählt haben.
  • Endpunkte
    • Die Liste der Endpunkte, für die Ihre App Zugriff benötigt.
    • Sie müssen mindestens einen Endpunkt ausgewählt haben.
Optionale Felder sind unten aufgeführt:
  • Verhalten bei benutzerdefinierten Feldern
    • Das Verhalten bei benutzerdefinierten Feldern, das Ihre App befolgt. Weitere Informationen zu dieser Einstellung finden Sie unter Verwaltung benutzerdefinierter Felder.
    • Darf nicht „Für alle Felder aktiviert“ sein, sofern die App für das App Directory eingereicht wird.
  • OAuth-Domain-Weiterleitung
    • Gültige Liste von Domains
    • Eine Liste gültiger Domains, auf die Yext umleiten wird, nachdem ein Kunde den OAuth-Vorgang abgeschlossen hat. Die Domain in Ihrer REDIRECT_URI muss exakt mit einer Domain aus dieser Liste (einschließlich Subdomains) übereinstimmen.
  • API-Schlüssel
    • Eine Liste der API-Schlüssel, die zur Authentifizierung Ihrer App während des Austauschs von OAuth-Zugriffstokens, sowie für den Zugriff auf Ihre eigene Instanz des Knowledge Manager verwendet werden.
    • Betrachten Sie diese Schlüssel als Geheimnisse Ihrer Kunden. Geben Sie sie niemals außerhalb einer sicheren Verbindung während App-Aufrufen mit Yext preis.
Nach oben

App-Directory-Konfiguration

Damit Ihre App im App Directory von Yext aufgeführt werden kann, müssen Sie, bevor Sie den Einreichungsprozess beginnen, Werte für alle „App Directory“-Felder angeben. Diese Felder sind:
  • Logo
    • Mindestens 250 x 250 px
    • Ein Logo, das Ihre App repräsentiert. Dieses Bild enthält in der Regel das Logo der Plattform, für die Ihre App eine Integration bietet.
  • Kategorien
    • Nicht mehr als drei Kategorien
    • Bis zu drei Kategorien, die den Zweck Ihrer App beschrieben. Die erste von Ihnen ausgewählte Kategorie wird Ihre Hauptkategorie sein, die in den App-Directory-Listen aufgeführt wird.
    • Aktuelle Kategorien:
      • Werbung & Marketing
      • Analytik & Business Intelligence
      • Inhaltserfassung
      • Kundenbeziehungsmanagement
      • Kunden-Interaktionen
      • Kundensupport
      • E-Mail
      • Facility-Management & HR
      • Gesundheitswesen
      • Point-of-Sale
      • Social
      • Übersetzung
      • Websites
  • Kurze Tagline
    • Bis zu 100 Zeichen
    • Eine kurze Beschreibung, die in den App-Directory-Listen neben dem Namen Ihrer App erscheinen wird. Dieser Text sollte kurz und bündig beschreiben, was Ihre App tut.
    • Beispiel: „Synchronisiert Yext-Standortdaten mit BeispielCo-CRM“
  • Detaillierte Beschreibung
    • Bis zu 5.000 Zeichen
    • Eine ausführliche Beschreibung, die auf Ihrer Detailseite im App Directory angezeigt wird.
    • Verwenden Sie diesen Text, um zu beschreiben, was Ihre App tut und fügen Sie dort Marketingtext, die Nutzungsanforderungen der App und grundlegende Installationsanweisungen hinzu.
  • Vimeo-Video-URL
    • Gültige URL für ein Vimeo-Video
    • Ein Video, das Kunden die Funktionen Ihrer App demonstriert. Dieses Video wird auf der Seite Ihres App-Eintrags eingebettet.
    • Das Video sollte informativ und von hoher Qualität sein. Es sollte Kunden durch die Einrichtung der App führen, erklären, wie sie funktioniert und welchen Wert die App ihnen bringt.
  • App von
    • Bis zu 50 Zeichen
    • Der Name des Entwicklers, so wie er im App Directory angezeigt werden soll.
  • Startseite
    • Gültige URL
    • Homepage Ihrer App. Diese URL kann auf eine Seite verlinken, die sich speziell auf Ihre App bezieht, oder alternativ auf die Homepage der externen Plattform weiterleiten.
  • E-Mail-Adresse des Kundendienstes
    • Gültige E-Mail-Adresse
    • Eine E-Mail-Adresse, an die Kunden Fragen, Kommentare und Support-Anfragen senden können.
  • Nutzungsbedingungen
    • Gültige URL
    • Ein Link zu den allgemeinen Nutzungsbedingungen Ihrer App.
  • Datenschutzrichtlinie
    • Gültige URL
    • Ein Link zur Datenschutzrichtlinie für die App.
  • App-Installations-URL
    • Gültige URL
    • Die URL, die Ihre App startet, sofern die App nicht bereits mit einem Kunden verbunden ist („installiert“).
    • Überlegen Sie, ob dem Nutzer nach dem Klicken eine Übergangsseite (Splash-Page) angezeigt wird, die vor dem Beginn des OAuth-Vorgangs über die Funktionalitäten der App informiert.
    • Falls gewünscht, können die URL für die App-Installation und die URL für den App-Start identisch sein.
  • App-Veröffentlichungs-URL
    • Gültige URL
    • Die URL, die Ihre App startet, falls Ihre App bereits mit einem Kunden verbunden ist („installiert“).
    • Erwägen Sie zudem, Kunden direkt zum OAuth-Prozess zu leiten, um so direkt die Authentifizierung/Autorisierung einzuleiten und die Konfiguration der App zu starten.
    • Falls gewünscht, können die URL für die App-Installation und die URL für den App-Start identisch sein.
  • Test-Anweisungen
    • Im Verlauf des App-Einreichungsprozesses zusammengetragen.
    • Anweisungen an das App Directory Review Team von Yext dazu, wie auf die volle Funktionsfähigkeit der App getestet werden soll. Stellen Sie Anmeldedaten für Test-Benutzerkonten und eine schrittweise Anleitung zur Nutzung der App zur Verfügung.
    • Wenn wir Ihre App unter Verwendung dieser Anweisungen nicht vollständig testen können, werden wir erneut Kontakt mit Ihnen aufnehmen. Dies wird jedoch Ihre Genehmigung für das App Directory verzögern.
  • Video-URL
    • Im Verlauf des App-Einreichungsprozesses zusammengetragen.
    • Gültige URL
    • Ein optionales Video, das dem App Directory Review Team die Funktionalitäten Ihrer App demonstriert.
    • Wir empfehlen nachdrücklich, ein solches Video bereitzustellen, da dies die Überprüfungszeit für Ihre App deutlich verkürzen wird.
Nach oben

Yext Markenrichtlinien

Falls Sie in Ihrer App vom Yext-Branding Gebrauch machen, tun Sie dies bitte ausschließlich unter Einhaltung unserer Markenrichtlinien, wie sie auf Brandfolder beschrieben sind. Verwenden Sie zudem nur die Elemente, die dort zur Verfügung gestellt werden.

Nach oben

Referenz-App-Implementierung

Wir haben eine beispielhafte Referenz-App entwickelt, die auf GitHub gehostet wird. Diese Referenz-App soll Ihnen dabei helfen, besser nachzuvollziehen, wie eine App auf Basis unserer Best Practices erstellt werden sollte.

Nach oben