Yelp Integration

Introduction

Integrating Yelp's rich data and services into your eDirectory website can significantly enhance its value by providing users with trusted reviews and business information. This integration is made possible through the Yelp API (Application Programming Interface), which requires a unique API key for access. Creating this key is a straightforward process involving registration for a Yelp Developer account and the generation of your unique credentials. This step-by-step guide will walk you through the process of obtaining your Yelp API key and integrating it with your eDirectory platform.

Step 1: Creating a Yelp Developer Account:

1. Visit the Yelp Developer website: Navigate to https://www.yelp.com/developers.

2. Sign in or create an account:
   • If you already have a Yelp user account, sign in using your existing email address and password.
   • If you don't have a Yelp account, you will need to create a new one by following the on-screen registration process.

3. Access Yelp Fusion: On the subsequent page, locate and click on "Yelp Fusion."

4. Manage App: Click on the "Manage App" button.

Step 2: Creating a New App:

1. Go to the Yelp Developer Dashboard. If you are not automatically redirected after Step 1, you can usually find the dashboard link on the Yelp Developers website.
2. Click on the "Create App" option.

3. Fill in the App Details: You will be presented with a form to provide information about your application. Please complete the following fields:
   • App Name: Enter a unique and descriptive name for your application. This will help you identify it within your Yelp Developer account.
   • App Website: Provide the complete URL (e.g., https://www.yourwebsite.com ) of the website where you intend to integrate the Yelp API functionality (your eDirectory site).
   • App Industry: Select the industry that best describes your business or website.
   • Contact Email: Type your valid email address. Yelp may use this for communication regarding your API access.
   • App Description: Briefly describe the purpose and functionality of how you plan to use the Yelp API on your eDirectory website. Be clear and concise.
4. Read and Accept the Terms of Use: Carefully review Yelp's API Terms of Use. You will need to indicate that you have read and agree to these terms, usually by checking a box.
5. Verify that you are not a robot: Complete the CAPTCHA challenge as prompted.
6. Click "Create App": After filling in all the necessary information and accepting the terms, click on the "Create App" button to generate your Yelp API key.

Step 3: Retrieving Your API Key:

1. Once your app is successfully created, you will be automatically redirected to your App Dashboard within the Yelp Developer portal.
2. Locate the section clearly labeled "API Key" on your App Dashboard. Your unique Yelp API key will be displayed within this section.
3. Copy Your API Key: Carefully select and copy the entire API key. It is usually a long string of alphanumeric characters.

Step 4: Implementing Your Yelp API Key in eDirectory:

Now that you have obtained your unique Yelp API key, you can integrate it into your eDirectory website to begin accessing and displaying Yelp's valuable data.

1. Log in to your site manager dashboard on your eDirectory website using your administrative credentials.
2. Navigate to Settings → General Settings → Plugins.

3. On the "Plugins" tab, find the section dedicated to Yelp integration settings.
4. Within the Yelp integration settings, locate the field labeled "API Key." Paste the Yelp API key that you copied in Step 3 into this field.
5. Click on the "Validate Yelp Key" button (if available) to ensure the key is correctly formatted and accepted by the system.
6. Finally, click the "Save Changes" button to store your Yelp API key within your eDirectory settings.

Important Notes:

• Protect Your API Key: Treat your Yelp API key with the same level of security as any other sensitive login credential. Avoid sharing it publicly or embedding it directly in client-side code (like JavaScript in your website's front-end), as this could allow unauthorized access.
• Review Yelp's API Terms of Use: It is crucial to thoroughly read and understand Yelp's API Terms of Use to ensure your integration complies with their guidelines, policies, and any restrictions on data usage or display.
• Monitor Usage and Limits: Be mindful of your API usage and familiarize yourself with any rate limits imposed by Yelp on API requests. Exceeding these limits can lead to temporary service disruptions. The Yelp Developer Dashboard may provide insights into your API usage.

Review Display:

Once the Yelp API key is successfully validated and saved within your eDirectory settings, the system will attempt to automatically associate listings on your site with corresponding businesses on Yelp. This matching process typically relies on identifying listings with the same name and in the same location as they appear on Yelp. If a match is found, along with other relevant information such as images, ratings, phone number, and more, the Yelp reviews for that business will be loaded and displayed automatically on the corresponding listing page on your eDirectory website.

Conclusion

By diligently following these steps, you will have successfully created a Yelp API key and integrated it into your eDirectory website, unlocking the potential to enrich your platform with valuable Yelp reviews and business information for your users.