Quoteable Service documentation
Quoteable Service is a mock API for managing subscribers and the quotes they want to receive. The service is built with JSON Server and is intended for learning, testing, and API documentation practice.
The API has two resources:
subscribers: Stores subscriber contact details, delivery preferences, and quote category preferences.quotes: Stores quote records associated with subscribers.
Get started
Follow the instructions in these topics to prepare your environment and get started:
API reference
Use {base_url} for the server URL. When you run the mock API locally, {base_url} is:
http://localhost:3000
Subscribers endpoints
The following table lists endpoints for the subscribers resource.
| Method | Endpoint | Description |
|---|---|---|
| GET | /subscribers |
Retrieve all subscribers. |
| GET | /subscribers/{id} |
Retrieve one subscriber by ID. |
| POST | /subscribers |
Create a subscriber. |
| PATCH | /subscribers/{id} |
Update part of a subscriber. |
| PUT | /subscribers/{id} |
Replace a subscriber. |
| DELETE | /subscribers/{id} |
Delete a subscriber. |
For details on the subscribers resource, see the subscribers resource overview.
Quotes endpoints
The following table lists endpoints for the quotes resource.
| Method | Endpoint | Description |
|---|---|---|
| GET | /quotes |
Retrieve all quotes. |
| GET | /quotes/{id} |
Retrieve one quote by ID. |
| POST | /quotes |
Create a quote. |
| PATCH | /quotes/{id} |
Update part of a quote. |
| PUT | /quotes/{id} |
Replace a quote. |
| DELETE | /quotes/{id} |
Delete a quote. |
For details on the quotes resource, see the quotes resource overview.
Tutorials
Follow these tutorials to practice common API tasks:
- Create a subscriber and add their first quote
- Add a custom quote for a subscriber
- Update a subscriber’s email or mobile number
- Update a subscriber’s quote preferences
- Modify a subscriber’s quote frequency
- Change a subscriber’s quote delivery method
- Retrieve all quotes for a subscriber
- Implement basic error handling
Limitations
This project uses JSON Server to simulate an API. It does not include authentication, production validation, rate limits, or a custom backend.