API YEXT into APP
Budget: $1,500 – $3,000 USD
Synchronize, in real-time, data from the Yext Knowledge Graph into a
website. We have location(s) data for businesses stored in Yext
which they wish to also make available inside of a web app. This will enable
designers to use this data while designing & building the
website. Then, when data is updated in Yext, it will also be updated in the
content library and passed into the live website.
High-Level Timeline
We estimate that the development effort is one month from a single
developer, with a few weeks of time for QA & Feedback.
Month Task
February
Align resources
Create mapping document
(Yext Fields → Platform Fields)
Map widgets 100%
UI Designs created
Finalize scope
Development/implementation
March
Feedback
API implementation
Production deployment
Solution
We will implement an App (in the platform App Store), specifically for connecting
Yext to a platform website. This App will only be available to select accounts (or accounts for which we configure) and not all customers
This middleman App Stores API keys (from App Store) and Yext API keys
in order to perform the synchronization between platform and Yext.
The App will have a minimal UI in order to configure the sync between Yext
and the platform. For example, it might have an option to add new location IDs from
Yext, disable sync on a single location or more, depending on scope.
We’ll also store the last sync result (success/fail, fail message, timestamp) and
present it in the UI so that if something fails, there’s a place to start
troubleshooting from.
Workflow
In order to set up the sync between a platform website and Yext, We will have it setup:
1. Via API, install the Yext App
2. Pass the App details about the customer account ID from the customer (and
maybe other data)
3. Upon installation, the App will fetch all data from Yext and push it into
the content library or collection(s) of the website.
4. The App will listen to content update webhooks from Yext and then
respectively update the platform content library with this data
5. The App will also publish the content library data after updating the
content library. This will ensure that the live website is updated in
real-time with fresh data.
Technology
The App will use the following infrastructure and tech:
● Hosted in our AWS instance
● Use Lambda to run code / API / Webhook events
● Store data (probably MySQL)
● Node.js (latest version supported by Lambda)
○ Express JS
○ Nde API Client Library
● React for app interface (hosted in S3)
website. We have location(s) data for businesses stored in Yext
which they wish to also make available inside of a web app. This will enable
designers to use this data while designing & building the
website. Then, when data is updated in Yext, it will also be updated in the
content library and passed into the live website.
High-Level Timeline
We estimate that the development effort is one month from a single
developer, with a few weeks of time for QA & Feedback.
Month Task
February
Align resources
Create mapping document
(Yext Fields → Platform Fields)
Map widgets 100%
UI Designs created
Finalize scope
Development/implementation
March
Feedback
API implementation
Production deployment
Solution
We will implement an App (in the platform App Store), specifically for connecting
Yext to a platform website. This App will only be available to select accounts (or accounts for which we configure) and not all customers
This middleman App Stores API keys (from App Store) and Yext API keys
in order to perform the synchronization between platform and Yext.
The App will have a minimal UI in order to configure the sync between Yext
and the platform. For example, it might have an option to add new location IDs from
Yext, disable sync on a single location or more, depending on scope.
We’ll also store the last sync result (success/fail, fail message, timestamp) and
present it in the UI so that if something fails, there’s a place to start
troubleshooting from.
Workflow
In order to set up the sync between a platform website and Yext, We will have it setup:
1. Via API, install the Yext App
2. Pass the App details about the customer account ID from the customer (and
maybe other data)
3. Upon installation, the App will fetch all data from Yext and push it into
the content library or collection(s) of the website.
4. The App will listen to content update webhooks from Yext and then
respectively update the platform content library with this data
5. The App will also publish the content library data after updating the
content library. This will ensure that the live website is updated in
real-time with fresh data.
Technology
The App will use the following infrastructure and tech:
● Hosted in our AWS instance
● Use Lambda to run code / API / Webhook events
● Store data (probably MySQL)
● Node.js (latest version supported by Lambda)
○ Express JS
○ Nde API Client Library
● React for app interface (hosted in S3)