Häufig gestellte Fragen
  • Ich habe bereits ein Yext-Abonnement. Muss ich ein Entwicklerkonto anlegen, um Ihre APIs zu verwenden?

    Nein, Sie können sich mit Ihrem bestehenden Yext-Konto anmelden und einen API-Key in Ihrer Entwicklerkonsole erstellen. Weitere Informationen finden Sie in unserer Anleitung Erste Schritte .

    Enterprise-Kunden, die Standorte hinzufügen oder aktualisieren möchten, kontaktieren bitte vor der Erstellung eines API-Schlüssels den zuständigen Kundenbetreuer.

    Wenn Sie nicht auf Ihre Entwicklerkonsole zugreifen können, kontaktieren Sie bitte Ihren Kundenbetreuer.

  • Ich habe ein kostenloses Konto, möchte aber eine API verwenden, die ein Yext-Abonnement erfordert. Wie kann ich mich registrieren?

    Schreiben Sie eine E-Mail an apisupport@yext.com. Ein Mitglied des API-Support-Teams wird Ihnen dann bei der Auswahl des Abonnements helfen, das Ihren Bedürfnissen entspricht.

  • Wird v1 Ihrer APIs weiterhin unterstützt?

    Ja, wir planen, v1 mindestens noch bis Ende 2017 zu unterstützen. Allerdings werden neue Funktionen für unsere APIs nur in v2 verfügbar sein.

  • Ich verwende momentan v1 Ihrer APIs. Wie nehme ich ein Upgrade auf v2 vor?

    Zur Verwendung von v2 unserer APIs rufen Sie Ihre Entwicklerkonsole auf und erstellen Sie eine App, um einen API-Key für v2-Endpunkte zu erhalten.

    Sie können die v1-Endpunkte auch nach Erhalt Ihres v2-API-Keys verwenden. Der Übergang zu v2 kann pro Endpunkt erfolgen. Sie können jedoch auch zu einem beliebigen Zeitpunkt nur noch v2-Endpunkte verwenden.

    Bitte beachten Sie jedoch, dass Ihr v2-API-Key nicht zum Senden von Anfragen an v1-Endpunkte genutzt werden kann. Umgekehrt funktioniert dies ebenfalls nicht. Außerdem gibt es Unterschiede zwischen den Anfragen und Antworten der Versionen. Wenn Sie ein Upgrade versuchen, indem Sie in Ihren Anfragen „v1“ gegen „v2“ austauschen, wird Ihre Integration abstürzen.

    Informationen zu den jeweiligen Endpunkten in v2 finden Sie in der API-Referenz.

  • Kann ich sowohl v1- und v2-Endpunkte verwenden, um einen Endpunkt nach dem anderen auf v2 umzustellen?

    Ja. Sie können zum Beispiel den Endpunkt „Standort erstellen“ von v2 und den Endpunkt „Bewertungen auflisten“ von v1 verwenden.

  • Ich habe das API-Support-Team um Hilfe gebeten. Wann kann ich mit einer Antwort rechnen?

    Ein Teammitglied wird Ihnen innerhalb eines Werktags antworten, wenn Sie ein laufendes Abonnement haben, oder innerhalb von sieben Werktagen, wenn Sie ein kostenloses Konto nutzen.

  • Wie kann ich die Geschäftszeiten eines Standorts in der API formatieren?

    Unsere API unterstützt dasselbe Geschäftszeitenformat wie Google My Business. In unserer Knowledge-Manager-Dokumentation finden Sie weiterführende Informationen.

  • Wie wird meine API-Nutzung von meinem Kontingent abgerechnet?

    Die Berechnung der API-Nutzung erfolgt auf stündlicher Basis. Ein stündliches Kontingent wird für jede angefangene Stunde (ab Minute 0, „:00“), also nicht erst nach 60 Minuten, berechnet.

  • Kann ich Standorte über die API hinzufügen, ohne für sie die Dienstleistungen von Yext zu abonnieren?

    Ja. Erfahren Sie mehr darüber n unserem Guide Standorte managen.

  • Können Unternehmenskunden Lizenzen über die API zuweisen oder die Zuweisung aufheben?

    Nein, wir bieten Unternehmenskunden keinen Zugang zum Lizenzmanagement. Wenn API-Kunden neue Standorte hinzufügen wird unser Support automatisch darüber benachrichtigt. Je nach Vorlieben des Kunden ordnet der Support dem neuen Standort sofort eine Lizenz mit normalen SLAs zu, wenn Lizenzen verfügbar sind, oder bittet den verantwortlichen Kundenbetreuer um Genehmigung, um eine Lizenz zuzuordnen.

  • Welches Datenformat akzeptiert die API?

    Unsere API akzeptiert nur Daten im JSON-Format.

  • Welche Felder muss ich übermitteln, wenn ich einen neuen Standort hinzufüge?

    Sie müssen Informationen zu den folgenden Feldern übermitteln:

    • id (Geschäftskennung)
    • Standortname
    • Adresse
    • Stadt
    • Bundesstaat
    • Postleitzahl
    • Ländercode
    • Telefonnummer
    • categoryIds (muss mindestens eine Kategorie enthalten)

    Wenn Sie bei featuredMessage keinen Wert eingeben, ist die Standardeinstellung für „Mein Highlight“-Nachrichten „Jetzt anrufen!“.

  • Verwende ich in meinem Sandbox-Konto dieselben Anmeldedaten und dieselbe Unternehmens-ID wie in der Produktion?

    Nein, die Unternehmens-ID und die Anmeldedaten, die wir während der Tests zur Verfügung stellen, gelten nur für das Sandbox-Konto. Sobald Sie für die Produktion zugelassen wurden, werden wir Ihnen neue Anmeldedaten und eine Unternehmens-ID ausstellen.

  • Kann ich meine Geschäftskennung über die API ändern?

    Ja, aber wir müssen diese Funktion für Ihr Konto gesondert aktivieren. Allgemein raten wir Unternehmen davon ab, die IDs Ihrer Standorte zu ändern. Dies macht es ihren IT-Teams schwerer, die Integration aufrechtzuerhalten.

  • Was passiert, wenn ein Fehler unterläuft?

    Unsere API sendet daraufhin eine ausführliche Fehlermeldung und einen Antwortcode. Unter Fehlermeldungen finden Sie weiterführende Informationen.

  • Kann ich täglich einen vollständigen Eintrag für jeden Standort schicken, statt nur die Änderungen, die ich vorgenommen habe?

    Das ist möglich, wenn Sie das wünschen. Dennoch empfehlen wir, falls möglich nur die Änderungen zu schicken, da wir alle Änderungen aufbewahren wollen, die Nutzer oder Yext-Mitarbeiter vornehmen, um Datenprobleme oder Ungenauigkeiten zu beheben.

  • Gibt es einen standardisierten Testplan für die Integration mit Ihren APIs?

    Auch wenn die Abläufe leicht variieren können, ist es im Regelfall erforderlich, dass Kunden ihre API-Integration testen, indem sie:

    • mindestens einen Standort hinzufügen,
    • den Standort testweise schließen und
    • mehre Standorte aktualisieren.

    Unser Support-Team wird Ihnen zu Beginn des Integrationsprozesses einen ausführlicheren, kundenspezifischen Plan schicken.

  • Warum werden bei meiner GET-Anfrage nur 50 Ergebnisse angezeigt, obwohl in meinem Konto mehr vorhanden sind.

    Die Anzahl der Ergebnisse für GET-Anfragen sind bei Yext auf 50 beschränkt.Um mehr Ergebnisse sehen zu können, müssen Sie Ihre GET-Anfrage paginieren. Je nachdem, welche Daten Sie abrufen, können Sie die Parameter limit und offset verwenden, um Seiten für die Ergebnisse zu erstellen, oder den Parameter pageToken und das Feld nextPageToken nutzen, um diesen Prozess zu automatisieren. In der Dokumentation über jeden Ihrer GET-Endpunkte finden Sie weiterführende Informationen.

  • Warum stoße ich an eine Ratenbegrenzung?

    Sie senden zu viele Anfragen pro Stunde.

    Weiterführende Informationen zu derzeitigen Ratenbegrenzungen finden Sie unter „Kontingente und Zeitbeschränkungen“ in unseren Richtlinien und Konventionen.

  • Werden Webhook-Anfragen bei meiner Ratenbegrenzungen berücksichtigt?

    Nein, Webhook-Anfragen werden bei Ihrer Ratenbegrenzungen nicht mitgezählt.

  • Woher weiß ich, ob ich die Obergrenze erreicht habe?

    Sie erhalten die Fehlermeldung 429, in der wir Ihnen mitteilen, dass Sie Ihre Ratenbegrenzungen erreicht haben.

  • Kann ich meine Frequenz-Obergrenze erhöhen?

    Es ist nicht möglich, Ihre Ratenbegrenzungen zu erhöhen.

    Sie sollten Ihre Anfragen drosseln oder deaktivieren, um die Ratenbegrenzungen nicht zu überschreiten.

  • Können Sie Standorte über API „schließen“?

    Ja. Obwohl wir Kunden keinen Zugang zum Lizenzmanagement gewähren, können Sie Inhalte für geschlossene Standorte übermitteln (z. B. den Namen in „[Name] – Geschlossen“ ändern, alle Öffnungszeiten auf „Geschlossen“ stellen, Ihre „Mein Highlight“-Nachricht und deren URL aktualisieren etc.). Wir empfehlen Ihnen zwei allgemeine Strategien – je nachdem, ob Sie die geschlossenen Standorte beibehalten oder sie aus dem Abonnement entfernen wollen.

    • Geschlossene Standorte beibehalten: Wenn Sie geschlossene Standorte beibehalten wollen, empfehlen wir Ihnen, die oben genannten Empfehlungen für Inhalte für geschlossene Standorte umzusetzen und das Feld geschlossen auf „wahr“ zu setzen. Bitte benachrichtigen Sie uns, wenn Sie die Standorte aus dem Abonnement nehmen wollen.
    • Geschlossene Standorte nicht beibehalten: Wenn Sie geschlossene Standorte aus Ihrem Abonnement entfernen wollen, empfehlen wir Ihnen, die oben genannten Empfehlungen für Inhalte für geschlossene Standorte umzusetzen und das Feld geschlossen nicht auf „wahr“ zu setzen. Wir werden den Standort innerhalb einer Woche aus Ihrem Abonnement nehmen.
  • Was sind häufige Probleme im Bereich der Datenbereinigung oder Datenintegrität, die wir berücksichtigen sollten?

    Nachfolgend finden Sie eine Liste von Schwierigkeiten, die uns bei Kundendaten häufiger begegnen. Vielleicht möchten Sie Ihre Datenbank vor der Integration entsprechend aktualisieren.

    • Daten in Großbuchstaben – Sie sollten alle Daten für alle Felder in der normalen Groß- oder Kleinschreibung übermitteln (Ausnahme: Sie können in Ihrem Unternehmensnamen Großbuchstaben verwenden, wenn das die Schreibweise Ihres eingetragenen Namens ist)
    • Postfach Postfächer in Adressen – Postfach Postfächer werden von Yext, unseren Publishern und Google nicht akzeptiert
    • Informationen über das Einkaufszentrum in den Feldern address oder address2 – diese Information sollte in den Feldern address3 oder displayAddress enthalten sein.
    • Ungültige Telefonnummern (z. B. 000-000-0000 oder 999-999-9999 oder Ländervorwahlen, die nicht mit dem Standortland übereinstimmen)
    • Nicht ausgefüllte Geschäftskennungen – für die API-Integrationen werden eindeutige Geschäftskennungen (id-Werte) benötigt
    • HTML in der Beschreibung
    • Ungültige Foto-URLs
    • Ungültige Website-URLs
    • Die Einstellungen Ihres twitterHandle auf „twitter.com/handle“ kann nur als „@handle“ oder „handle“ formatiert werden
    • Ungültige facebookPageUrl – diese URL sollte nur auf die Hauptseite führen und nicht auf eine Subdomain
    • Geo-Modifier im Unternehmensnamen, es sei denn, dies ist der offizielle Name des Standorts
  • Muss ich alle Inhaltsfelder übermitteln oder kann ich Inhaltsvorlagen über die API verwenden?

    Sie können beim Einrichten eines Standorts eine Inhaltsvorlage verwenden. Wir empfehlen Ihnen, eine Vorlage zu verwenden, in der so viele Inhalte wie möglich vorhanden sind, sodass Sie bei Bedarf den Feldwert auf unserer Plattform ändern können (z. B. Ihre Unternehmensbeschreibung oder ein benutzerdefiniertes Feld).