Generování recenzí Yext umožňuje firmám zasílat zákazníkům e-mailové a SMS pozvánky s žádostmi o recenze pomocí adresy URL pro vyvažování recenzí. Tato adresa URL přesměrovává uživatele na weby s recenzemi třetích stran a/nebo na stránku pro sběr vlastních recenzí, v závislosti na distribuci, kterou nastavíte pro algoritmus vyvažování recenzí. Více informací o algoritmu vyvažování recenzí najdete v návodu Začínáme s recenzemi.
Pomocí rozhraní API pro správu pozvánek můžete provést integraci s externím systémem a spravovat pozvánky programově.
Integrační vzory
Většina integrací pozvánek k recenzím využívá jeden ze dvou vzorů.
Push: váš externí systém upozorní vaši aplikaci, jakmile dojde k aktivaci spouštěče, a vaše aplikace následně vytvoří pozvánku. Mezi běžné spouštěče push patří:
- Zákazník obdrží produkt a systém plnění signalizuje, že dodání je dokončeno.
- Zákazník dokončí nákup na fyzickém místě a systém pokladního místa signalizuje, že transakce je dokončena.
- Pacient dokončí návštěvu a plánovací systém signalizuje, že se stav schůzky aktualizoval.
Pull: vaše aplikace pravidelně načítá data, která spouštějí pozvánky, namísto přijímání oznámení v reálném čase. Integrace typu „pull“ jsou běžné v případech, kdy externí systém nepodporuje webhooky pro příslušný spouštěč nebo kdy jsou data pozvánek exportována do umístění FTP podle plánu.
Koncové body API pro pozvánky k recenzím
| Koncový bod | Popis | URL |
|---|---|---|
| Review Invitations: Create | Vytvoří novou pozvánku k recenzi | POST https://api.yextapis.com/v2/accounts/{accountId}/reviewInvites |
| Review Invitations: Get/List | Načte existující pozvánky k recenzím | GET https://api.yextapis.com/v2/accounts/{accountId}/reviewInvites |
| Review Invitations: Update | Aktualizuje existující pozvánku k recenzi | PUT https://api.yextapis.com/v2/accounts/{accountId}/reviewInvites/{uid} |
| Review Invitations: Delete | Smaže existující pozvánku k recenzi | DELETE https://api.yextapis.com/v2/accounts/{accountId}/reviewInvites/{uid} |
Pole pozvánky
Pozvánka obsahuje následující základní pole. V textu požadavku jsou vyžadována další pole; úplný odkaz naleznete v dokumentaci API.
| Pole | Popis |
|---|---|
| ID subjektu* | Subjekt, u kterého je požadována recenze. |
| Jméno* | Jméno osoby, od které je recenze požadována. |
| Příjmení* | Příjmení osoby, od které je recenze požadována. |
| Funkce | Titul osoby, od které je požadována recenze, například pan, paní nebo slečna. |
| Kontakt* | E-mailová adresa nebo telefonní číslo osoby, od které je recenze požadována. |
| ID šablony: | Šablona použitá k formátování pozvánky. |
| ID transakce | ID transakce, na kterou se pozvánka vztahuje. |
| Názvy štítků recenze | Názvy štítků recenze, které se mají připojit k výsledné recenzi. |
| Další parametry URL | Objekt JSON s dvojicemi klíč-hodnota, které se mají připojit k adrese URL pro vyvažování recenzí. |
*Povinné pole.
Než začnete s vytvářením integrace, ujistěte se, že vaše aplikace dokáže vyplnit všechna potřebná pole.
Nastavení přístupu k rozhraní API
Vytvoření aplikace
Vytvořte aplikaci v konzoli pro vývojáře a udělte jí přístup k API pro pozvánky k recenzím. Pro koncové body Get/List postačuje přístup pro čtení. K vytvoření, aktualizaci nebo odstranění pozvánek je však vyžadováno oprávnění k úpravám. Pro vaši aplikaci bude vygenerován klíč API, který umožní přístup ke koncovým bodům služby „Pozvánky k recenzi“. Tento klíč API byste neměli zveřejňovat na stránkách na straně klienta, proto se ujistěte, že tuto aplikaci nepoužíváte pro žádné požadavky na straně klienta.
Vytvoření pozvánky
Po odeslání požadavku na koncový bod „Review Invitations: Create“ se odešle pozvánka na vámi zadaný kontakt. Systém pro generování recenzí vám zašle SMS, pokud uvedete telefonní číslo, nebo e-mail, pokud uvedete e-mailovou adresu.
Odpověď obsahuje dvě pole, která budete potřebovat pro pozdější požadavky:
-
invitationUid: jedinečný identifikátor pozvánky. -
feedbackUrl: úplná adresa URL obsažená v pozvánce sinvitationUidpřipojeným jako parametr dotazu. Když příjemce odešle recenzi z této adresy URL, zahrňteinvitationUiddo požadavku na vytvoření recenze, aby systém mohl recenzi přiřadit k dané pozvánce.
Přidání dalších podrobností do pozvánky
Rozhraní API podporuje dva způsoby, jak s pozvánkou předat dodatečný kontext, který pak můžete využít ve výsledné recenzi.
Štítky recenzí: hodnoty zadejte do pole reviewLabelNames. Když je vytvořena recenze s odpovídajícím invitationUid, tyto hodnoty jsou k recenzi přiřazeny jako štítky recenzí. Například předáním hodnoty „In-Store“ do reviewLabelNames se výsledné recenzi přiřadí štítek „In-Store“.
Další parametry URL: zadejte objekt JSON s dvojicemi klíč-hodnota do pole additionalURLParameters. Tyto údaje se připojují jako parametry dotazu k adrese URL pro zpětnou vazbu, takže je vaše stránka pro sběr může načíst a využít podle vašich potřeb, včetně odeslání dat do externího atribučního systému namísto jejich použití jako štítku.
Odeslání pozvánek z externího systému
Pokud vaše firma sama doručuje e-maily nebo SMS zprávy, můžete v Yext vytvořit záznam pozvánky, aniž by ji Yext musel vyřizovat, a to tak, že do textu požadavku zadáte sendInvitationFromYext = FALSE. To je užitečné, když:
- Chcete, aby Yext zůstal hlavním zdrojem informací o odeslaných pozvánkách, i když je rozesílá váš vlastní systém.
- Chcete přijímat recenze pouze od zákazníků, kteří obdrželi pozvánku, což vyžaduje dodatečné nastavení popsané níže.
Povinné UID pozvánky při odeslání
Ve výchozím nastavení umožňuje veřejná stránka pro sběr každému, kdo zná její URL, zanechat recenzi, což je přesně to, co mnoho firem chce. Pokud chcete omezit možnost odesílání pouze na pozvané zákazníky, aktivujte v nastavení účtu možnost Vyžadovat pozvánky pro vlastní recenze. Po aktivaci musí každý požadavek směřující na koncový bod „Review Submission: Create“ obsahovat platné invitationUid, jinak bude recenze zamítnuta.
Pokud vyřizujete pozvánky z externího systému a zároveň vyžadujete toto nastavení, odešlete vrácenou adresu feedbackURL svým zákazníkům sami poté, co vytvoříte záznam pozvánky s parametrem sendInvitationFromYext = FALSE.
Přesměrování pozvánek na vlastní stránku pro sběr
Ve výchozím nastavení směruje URL adresa pro vyvažování recenzí příjemce na standardní stránku pro sběr Yext. Pokud chcete přesměrovat vlastní pozvánky na vlastní stránku pro sběr:
- Přejděte do sekce Recenze > Generování > Nastavení.
- Povolte přepsání stránky pro sběr vlastních recenzí.
- Vyberte vlastní pole pro uložení vlastních URL, nebo si ho vytvořte, pokud ho ještě nemáte.
- Vyplňte toto vlastní pole u každého subjektu, který chcete přesměrovat.
Po dokončení těchto kroků se pole Stránka s vlastními recenzemi vyplní hodnotou z vašeho vlastního pole. Samotná adresa URL pro vyvažování recenzí se nemění; stále uplatňuje nastavení vašeho algoritmu vyvažování, aby určila, ke kterému vydavateli má směrovat, a používá vaši vlastní adresu URL, když směruje na vlastní recenzi.
Formátování pozvánek s šablonami
Šablony pozvánek určují, jak se pozvánka zobrazí příjemci. Yext podporuje jak e-mailové, tak SMS šablony, které si můžete na platformě upravit. Postup nastavení naleznete v sekci Šablony pro generování recenzí. Pokud při vytváření pozvánky nezadáte ID šablony, Yext použije výchozí šablonu vašeho účtu.
Dodržení CAN-SPAM
Zákon CAN-SPAM vyžaduje, aby komerční e-maily obsahovaly fyzickou poštovní adresu odesílatele. Pokud chcete odesílat pozvánky prostřednictvím e-mailového systému Yext, přidejte název značky a adresu do nastavení účtu pro generování recenzí. Yext tyto informace automaticky zahrne do zápatí e-mailů s pozvánkami.
Aktualizace nebo odstranění pozvánky
Pomocí koncového bodu Update můžete zrušit pozvánku, která ještě nebyla odeslána, nebo provést jiné změny před doručením. Pomocí koncového bodu Delete můžete trvale odstranit záznam pozvánky. Odstranění pozvánky nemá vliv na stav doručení pozvánky, která již byla odeslána.
Testování integrace
Před spuštěním integrace ji otestujte na neprodukčním nebo testovacím účtu. Pro automatizované testy, jako je například noční kontrola správnosti odesílání pozvánek vaší datovou pipeline, vytvořte testovací pozvánku a pak ji smažte pomocí koncového bodu Delete.