Best Practices
Um ein positives Benutzererlebnis zu gewährleisten und die Wahrscheinlichkeit der Genehmigung Ihrer App für die Aufnahme in das App Directory zu erhöhen, empfehlen wir, dass Sie sich nach den im Folgenden beschriebenen Best Practices richten.

Weitere Details über diese Best Practices finden Sie in den Leitfäden dieser Seite. Für einen leichteren Zugriff haben wir sie jedoch hier zusammengefasst.

Entwerfen Ihrer App

  • Yext-Kunden müssen zum einen sicherstellen, dass die bezüglich ihrer Marke hinterlegten Daten korrekt sind. Zum anderen liegt es in ihrer Verantwortung, diese Daten im Rahmen ihrer Rolle so zu nutzen, dass sie einen Mehrwert für ihr Unternehmen liefern. Als Entwickler sollten Sie diese Zielgruppe und deren Bedürfnisse bei der Erstellung Ihrer Apps stets im Hinterkopf behalten. Insbesondere sollte die Nutzung und Installation Ihrer App keine fortgeschrittenen technischen Kenntnisse oder die Beteiligung verschiedener Stakeholder erfordern.
  • Jede App sollte nur für einen bestimmten Anwendungsfall zwischen der Yext Knowledge Engine und einer anderen externen Plattform ausgelegt sein.
  • 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 Assets, die dort zur Verfügung gestellt werden.

OAuth

  • Wir haben für die Authentifizierung und Autorisierung ein OAuth 2.0-Standard-Framework implementiert. Die Umleitung zu unserem OAuth-Prozess erlaubt uns, Kunden sicher zu authentifizieren und entsprechend aufzufordern, die von Ihrer App angefragten Berechtigungen zu genehmigen oder abzulehnen. Weitere Informationen hierzu finden Sie unter OAuth und Berechtigungsumfänge.
  • Wir raten auch auf anderen Plattformen nachdrücklich zur Nutzung eines OAuth-Prozesses, um den Kunden entsprechend zu authentifizieren/autorisieren. Falls OAuth auf der anderen Plattform nicht zur Verfügung steht, kann Ihre App verlangen, dass der Kunde einen statischen API-Schlüssel zur Verfügung stellt. Von dieser Methode wird jedoch dringend abgeraten, da sie sich negativ auf das Benutzererlebnis auswirkt und Ihrer App mehr Berechtigungen einräumen kann, als sie tatsächlich benötigt.
  • Zur Abfrage der Authentifizierungsdaten des Kunden empfehlen wir die Verwendung eines Pop-up-Fensters der Größe 470 x 600 Pixel.
  • Apps haben in der Regel keinen separaten Speicher für Benutzerdaten. Wir empfehlen daher die Verwendung einer eindeutigen Konto-ID sowohl von Yext als auch von der anderen Plattform, um darüber den entsprechenden Benutzerkontext zu bestimmen. App-Konfigurationen können mit diesem Benutzerkontext verknüpft werden. Wenn ein Kunde die Authentifizierung und Autorisierung für ein passendes Yext-Konto und das andere Plattform-Konto angibt (unabhängig von den tatsächlichen Anmeldeinformationen), können ihm mit dieser Methode die gleichen App-Konfigurationen bereitgestellt werden. Weitere Details hierzu erhalten Sie unter Identifikation von Yext-Objekten.
  • Zugriffstokens sollten sicher aufbewahrt werden (z. B. im Ruhezustand verschlüsselt), da sie letztendlich analog zu Kundenpasswörtern sind. Geben Sie Zugriffstokens niemals außerhalb einer sicheren Verbindung mit Yext während API-Aufrufen preis.

Benutzerdefinierte Felder

Ihr Präfix für ein benutzerdefiniertes Feld sollte ein kurzer, einzigartiger und kundenseitiger String zwischen drei und 50 Zeichen Länge sein. Dieser String wird in der Regel den Namen der externen Plattform enthalten, mit der Ihre App integriert ist (z. B. „Zendesk“, „Salesforce“ oder „HubSpot“). Falls Ihr Verhalten bei benutzerdefinierten Feldern „Aktiviert für Felder mit Präfix“ ist, müssen alle Definitionen der von Ihnen verwalteten benutzerdefinierten Felder mit diesem String beginnen.

Entwickeln Ihrer App

  • Ist Ihre App entwickelt, empfehlen wir Ihnen, sie eingehend zu testen, um so ein fehlerfreies Benutzererlebnis zu gewährleisten.
  • Überlegen Sie, ob dem Nutzer nach Klick auf Ihre App-Installations-URL automatisch eine Übergangsseite (Splash-Page) angezeigt werden soll, die vor dem Beginn des OAuth-Prozesses über die Funktionalitäten der App informiert.
  • Erwägen Sie zudem, über Ihre URL für den App-Start den Kunden direkt zum OAuth-Prozess zu leiten, um so die Authentifizierung/Autorisierung einzuleiten und die App-Konfiguration aufzurufen.

Einreichen Ihrer App in das App Directory

Wenn Sie Ihre App einreichen, müssen Sie auch Informationen dazu angeben, die im App-Verzeichnis angezeigt werden können.

Wir haben untenstehend spezifische Empfehlungen für die einzelnen Inhaltsbereiche aufgeführt.

Kurzbeschreibung

Die Kurzbeschreibung soll prägnant und in einer Zeile die Funktionalität der App erläutern. Bitte beachten Sie, dass es hierbei keine Tagline, sondern eine kurze Beschreibung des Anwendungsfalls für Ihre App gefragt ist. Beschreibungen wie „Verbessern Sie Ihr Marketing mit den Tools von MegaCorp!“ sollten vermieden werden. Verwenden Sie stattdessen Aussagen wie „Unterstützen Sie Ihre MegaCorp-Werbekampagnen mit gezielten Standortdaten von Yext.“.

Detaillierte Beschreibung

Die lange Beschreibung ist die Informationsquelle für alle, die mehr über Ihre App erfahren möchten. Die Beschreibung muss einige bestimmte Angaben enthalten, damit Ihr Eintrag so attraktiv wie möglich ist:
  • Detaillierte Beschreibung der Funktionen der App, insbesondere in Bezug auf Yext-Daten
  • Schritt-für-Schritt-Anleitung zum Installieren der App
  • Einige grundlegende Informationen darüber, wozu Ihr Produkt dient
VERMEIDEN SIE MARKENSPEZIFISCHES MARKETING Wir bitten Sie nachdrücklich, in diesem Bereich von markenspezifischem Marketing abzusehen. Die App-Beschreibung dient ausschließlich zur Erklärung der spezifischen Funktionalität der App.
EXAMPLE Zendesk, Inc. builds software for better customer relationships. It empowers organizations to improve customer engagement and better understand their customers. Zendesk products are easy to use and implement. They give organizations the flexibility to move quickly, focus on innovation, and scale with their growth. Zendesk pulls all your customer information into one place, so you can track, prioritize, and solve customer support tickets with efficient, relevant, and personal communication. Take your customer support to the next level with the Zendesk For Reviews app.

With the Zendesk For Reviews app, you can optimize your customer support by streamlining workflows and leveraging customer information you already store in Zendesk with Yext. If you’re already using Yext Reviews to actively monitor your online reviews, you can see when customers express praise or criticism publicly via the reviews they leave on your website and sites across the Knowledge Network. Set the Zendesk for Reviews app to generate a support ticket whenever you a receive customer feedback that you want to track.

The app allows you to create efficient internal workflows and resolve issues more quickly, so you can show all your customers that you care about their experiences:
  • Set review workflows to automatically generate a support ticket when a customer leaves a review of a particular rating anywhere in the Knowledge Network
  • Bewertungen unterschiedlichen Teams innerhalb Ihres Unternehmens zuweisen, indem Sie die gewünschten Filter, u. a. Gesamtrating, Bewertungsinhalt und Ort, an dem die Bewertung abgegeben wurde, festlegen
  • Sicherstellen, dass auf jede Bewertung rasch und angemessen reagiert wird – unabhängig von der Art der Bewertung
Um diese App installieren zu können, benötigen Sie ein Zendesk-Konto mit einem Team-, Professional-, Enterprise- oder Elite-Abonnement. Sie müssen auch Ihre Zendesk-Subdomain (z. B. yext.zendesk.com) angeben. Und zu guter Letzt brauchen Sie ein Yext-Konto mit einem Professional- oder Ultimate-Abonnement.

App-Symbol

Für alle Apps im App-Verzeichnis von Yext ist ein einfaches Symbol mit hohem Wiedererkennungswert erforderlich, das die Aufmerksamkeit des Betrachters weckt. Dieses Symbol stellt Ihre erste Möglichkeit dar, auf einen Blick die Einzigartigkeit Ihrer App zu kommunizieren.

Weitere Informationen finden Sie in den Symbol-Richtlinien.

Video-URL

Sie können zudem ein Video hinzufügen, das die Funktionen Ihrer App veranschaulicht und detaillierte Installationsanweisungen enthält. Dies ist nicht zwingend erforderlich, wird von uns jedoch nachdrücklich empfohlen. App-Einträge werden von Yext-Händlern und -Kundenbetreuern als interne Informationsquelle genutzt, um Kunden dabei zu helfen, mehr über bestimmte Apps zu erfahren und diese zu installieren. Dementsprechend haben wir festgestellt, dass Apps, deren Einträge Videos enthalten, besser angenommen werden. Wenn Sie eine Video-URL angeben, verkürzt dies zudem wesentlich die Prüfungszeit für Ihre App, nachdem Sie sie eingereicht haben.

Bitte beachten Sie, dass wir derzeit nur Video-URLs von Vimeo unterstützen.