Get Started

This page shows you how to start using our API.

API (Application Programming Interface) allows applications to communicate with each other. Postman is a powerful tool for interacting with APIs, making it easy to test The Furniture Bros API. This guide will walk you through the basics of using Postman to get started with APIs.

---

🖥️ Getting Started with Postman

1

Install Postman

1. Visit Postman's website.

2. Download and install the Postman app for your operating system.

3. Launch Postman and create an account if required.

2

Import the Postman Collection

1. Download The Furniture Bros Postman collection using the "Run in Postman" button below:

1. Click the "Import collection" link.

3

Understand the Collection Structure

• Each collection consists of requests grouped into different categories.

• Click on a request to view:

  • URL: The API endpoint.

  • Method: GET, POST, PUT, DELETE, etc.

  • Headers: Metadata required by the API.

  • Body (if applicable): Data to send with POST or PUT requests.

Learn more about the structure of a REST API by visiting the making a request page.

4

Make Your First Request

1. Open the collection and select a request. For example, you can use the POST http://thefurniturebros.com/auth/register. This request is located under the Account category.

2. Fill out the "Body" tab with your account name, email and password.

3. Click "Send" to execute the request.

4. Review the response in the bottom panel:

   • Status Code: Confirms request success (e.g., 200 OK).

   • Body: Displays response data from the API.

5. If your request is successful, you will receive an API Key. This key acts like a password; it verifies your identify when making a request. Some endpoints require request to be made with an API Key, while some don't. Learn more about authentication.

---

🦶 Next Steps

• Explore the API’s full capabilities by running all the requests in the collection.

• Share the collection with your team using Postman’s sharing options.

• Start integrating The Furniture Bros API into your application.

By following this guide, you'll be able to use the provided Postman collection to interact with the API effectively.