Yelp¶
With Yelp modules in Ibexa Connect, you can:
-
search businesses, search businesses by phone, retrieve business details and list business reviews
-
search events and retrieve event details
To get started with Yelp, create an account at yelp.com
Connect Yelp to Ibexa Connect¶
To connect Yelp app, you need to obtain the API Key value from your Yelp account and insert them in the Yelp module scenario.
-
Log in to your Yelp account.
-
Click Manage App. Copy the API Key to a safe place.
-
Log in to your Ibexa Connect account, insert a Yelp module scenario and click the Add button next to the Connection field.
-
In the Connection name field, enter a name for the connection.
-
In the API Key field, enter the details copied in step 2 and click Save.
You have successfully established the connection. You can now begin editing your scenario and adding more Yelp modules. If your connection needs reauthorization at any point, follow the connection renewal steps here.
Business¶
You can search businesses, search businesses by phone, retrieve business details, and list business reviews using the following modules.
Get Business Details¶
Returns information about a business.
| Business ID | Enter the Business ID whose details you want to retrieve. |
| Locale | Select or map the locale of the business. |
Search Businesses¶
Searches for businesses.
| Limit | Set the maximum number of businesses Ibexa Connect will return during one execution cycle. The default value is 10. |
See the Yelp Business API reference for entering the field values to search for the businesses that match the specified value.
Search Business by Phone¶
Searches for businesses by phone number.
| Phone | Enter the phone number of the business whose details you want to search. |
| Locale | Select or map the locale of the business. |
| Limit | Set the maximum number of businesses Ibexa Connect will return during one execution cycle. The default value is 10. |
List Business Reviews¶
List reviews for a business.
| Business ID | Enter the Business ID whose business reviews you want to list. |
| Locale | Select or map the locale of the business. |
| Limit | Set the maximum number of business reviews Ibexa Connect will return during one execution cycle. The default value is 10. |
Events¶
You can search events and retrieve event details using the following modules.
Get Event Details¶
Returns information about the event.
| Event ID | Enter the Event ID whose event details you want to retrieve. |
| Locale | Select or map the locale of the event. |
Search Events¶
Search for events.
| Limit | Set the maximum number of events Ibexa Connect will return during one execution cycle. The default value is 10. |
See the Yelp Event API reference for entering the field values to search for the events that match the specified value.
Other¶
You can call APIs using the following module.
Make an API Call¶
Performs an arbitrary authorized API call.
Note
For the list of available endpoints, refer to the Yelp API documentation.
URL |
Enter a path relative to |
Method |
GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. |
Headers |
Enter the desired request headers. You don't have to add authorization headers; we already did that for you. |
Query String |
Enter the request query string. |
Body |
Enter the body content for your API call. |
Example of use - Search Events¶
The following API call returns all events from your account.
URL: /v3/events
Method: GET
Matches of the search can be found in the module's Output under Bundle > Body > events.
In our example 3 events were returned:
