Skip to content
Postman API Testing Tips

How To Use Yelp Api In Postman

API Testing Blog

Getting Started with Yelp API in Postman

Postman is a powerful tool for testing and interacting with APIs. This guide will demonstrate how to use Postman to work with the Yelp Fusion API, providing practical examples and step-by-step instructions.

Obtaining Your API Keys

Before you begin, you’ll need to obtain an API key from Yelp. Follow these steps:

  1. Visit the Yelp Fusion API website: https://www.yelp.com/developers/documentation/v3
  2. Click on “Manage Apps” and create a new app.
  3. Once created, you’ll find your API key in the app’s details page.

Setting Up Your Postman Environment

  1. Create a New Environment: In Postman, go to Environments and click on ”+ Create Environment”.
  2. Define Variables: Set up the environment variables for your Yelp API credentials. Name them YELP_API_KEY and YELP_API_BASE_URL. Populate YELP_API_KEY with your API key and set YELP_API_BASE_URL to https://api.yelp.com/v3.

Basic Request Example: Searching for Businesses

Let’s start with a simple example to search for businesses based on a given location.

  1. Create a New Request: In Postman, create a new request and name it “Search Businesses”.
  2. Set the HTTP Method: Choose “GET” as the HTTP method.
  3. Enter the Endpoint: In the request URL, paste {{YELP_API_BASE_URL}}/businesses/search (ensuring you are using your environment variable).
  4. Add Query Parameters: In the “Params” tab, add the following query parameters:
    • term: The search term (e.g., “restaurants”)
    • location: The location (e.g., “San Francisco, CA”)
  5. Set Headers: In the “Headers” tab, add the “Authorization” header with the value Bearer {{YELP_API_KEY}}.
  6. Send the Request: Click “Send”.

Example Request Body:

{
  "term": "restaurants",
  "location": "San Francisco, CA"
}

Example Response Body (JSON):

{
  "businesses": [
    {
      "id": "XXXXXXXXXXXXXXXXXXXXXXXX",
      "alias": "XXXXXXXXXXXXXXXXXXXXXXXX",
      "name": "XXXXXXXXXXXXXXXXXXXXXXXX",
      "image_url": "XXXXXXXXXXXXXXXXXXXXXXXX",
      "url": "XXXXXXXXXXXXXXXXXXXXXXXX",
      "review_count": XXX,
      "categories": [
        {
          "alias": "XXXXXXXXXXXXXXXXXXXXXXXX",
          "title": "XXXXXXXXXXXXXXXXXXXXXXXX"
        }
      ],
      "rating": XXX,
      "coordinates": {
        "latitude": XXX,
        "longitude": XXX
      },
      "location": {
        "address1": "XXXXXXXXXXXXXXXXXXXXXXXX",
        "city": "XXXXXXXXXXXXXXXXXXXXXXXX",
        "state": "XXXXXXXXXXXXXXXXXXXXXXXX",
        "zip_code": "XXXXXXXXXXXXXXXXXXXXXXXX",
        "country": "XXXXXXXXXXXXXXXXXXXXXXXX",
        "display_address": [
          "XXXXXXXXXXXXXXXXXXXXXXXX",
          "XXXXXXXXXXXXXXXXXXXXXXXX",
          "XXXXXXXXXXXXXXXXXXXXXXXX"
        ]
      },
      "phone": "XXXXXXXXXXXXXXXXXXXXXXXX",
      "distance": XXX
    }
  ],
  "total": XXX,
  "region": {
    "center": {
      "latitude": XXX,
      "longitude": XXX
    }
  }
}

Searching by Business ID

To retrieve details about a specific business, you will need to use their business ID.

  1. Create a New Request: Create a new request named “Get Business Details”.
  2. Set HTTP Method: Use “GET”.
  3. Endpoint: {{YELP_API_BASE_URL}}/businesses/{{business_id}}. Replace {{business_id}} with the desired business ID from the previous response.
  4. Authorization Header: Add the “Authorization” header with the value Bearer {{YELP_API_KEY}}.
  5. Send the Request: Send the request.

Example Request URL:

https://api.yelp.com/v3/businesses/XXXXXXXXXXXXXXXXXXXXXXXX

Example Response Body (JSON):

{
  "id": "XXXXXXXXXXXXXXXXXXXXXXXX",
  // ... (rest of the business details)
}

Managing Collections

The Yelp API allows you to create, update, and manage your own collections of businesses.

Creating a Collection:

  1. New Request: Create a new request named “Create Collection.”
  2. HTTP Method: “POST”.
  3. Endpoint: {{YELP_API_BASE_URL}}/collections.
  4. Headers: Add the “Authorization” header with the Bearer {{YELP_API_KEY}} value.
  5. Request Body:
{
  "name": "My Favorite Restaurants",
  "description": "A collection of my favorite places to eat",
  "business_ids": [
    "XXXXXXXXXXXXXXXXXXXXXXXX",
    "XXXXXXXXXXXXXXXXXXXXXXXX",
    "XXXXXXXXXXXXXXXXXXXXXXXX"
  ]
}

Updating a Collection:

  1. New Request: Create a “Update Collection” request.
  2. HTTP Method: “PUT”.
  3. Endpoint: {{YELP_API_BASE_URL}}/collections/{{collection_id}}. Replace {{collection_id}} with the ID of the collection to update.
  4. Headers: Add the “Authorization” header with the Bearer {{YELP_API_KEY}} value.
  5. Request Body: Use a JSON object similar to the “Create Collection” example, with the desired changes.

Deleting a Collection:

  1. New Request: Create a “Delete Collection” request.
  2. HTTP Method: “DELETE”.
  3. Endpoint: {{YELP_API_BASE_URL}}/collections/{{collection_id}}. Replace {{collection_id}} with the ID of the collection to delete.
  4. Headers: Add the “Authorization” header with the Bearer {{YELP_API_KEY}} value.

Requesting User Reviews

The Yelp API also provides access to user reviews.

  1. New Request: Create a request named “Get Business Reviews”.
  2. HTTP Method: “GET”.
  3. Endpoint: {{YELP_API_BASE_URL}}/businesses/{{business_id}}/reviews. Replace {{business_id}} with the desired business ID.
  4. Headers: Add the “Authorization” header with the Bearer {{YELP_API_KEY}} value.

Example Response Body (JSON):

{
  "reviews": [
    {
      "id": "XXXXXXXXXXXXXXXXXXXXXXXX",
      "text": "XXXXXXXXXXXXXXXXXXXXXXXX",
      "rating": 4,
      "time_created": "XXXXXXXXXXXXXXXXXXXXXXXX",
      "user": {
        "id": "XXXXXXXXXXXXXXXXXXXXXXXX",
        "name": "XXXXXXXXXXXXXXXXXXXXXXXX",
        "image_url": "XXXXXXXXXXXXXXXXXXXXXXXX",
        // ... more user details
      }
    }
  ],
  "total": XXX,
}

Exploring More API Features

The Yelp Fusion API provides a vast array of endpoints and options. Refer to the official API documentation for a complete list of available resources and their associated parameters.

Key Tips for Postman and the Yelp API:

  • Utilize Postman Collections: Group related requests into collections for efficient organization and testing.
  • Test Environment Variables: Use environment variables to store your API credentials and base URL, making your requests adaptable and easily managed.
  • Postman Test Scripts: Add powerful test scripts to your requests to automate checks and validation of responses.

By understanding the basics and exploring the documentation, you can effectively leverage the Yelp Fusion API for various software testing, automation, and development tasks using Postman.

API Testing Blog