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

Es wird dringend empfohlen, dass Sie im Verlauf des App-Einreichungsprozesses eine URL zu einem Video bereitstellen, das die Funktionalitäten Ihrer App veranschaulicht. Dies wird die Überprüfungszeit für Ihre App deutlich verkürzen.