The Santry API is the backbone of the Santry mobile application, designed to streamline food inventory management, recipe discovery, and personalized notifications. With a well-organized set of endpoints, the API empowers developers to create dynamic and user-friendly applications for managing food items, dietary preferences, and more.
In this blog, we’ll take a closer look at the Santry API’s endpoints, grouped into categories like User APIs, Food Item APIs, Recipe APIs, Notification APIs, and more. Whether you’re a developer working on a frontend integration or simply curious about the inner workings of Santry, this guide has everything you need to know!
User APIs
The User APIs help manage user-specific data, including profiles and dietary preferences. These endpoints are essential for personalizing the user experience.
GET /api/users/me/
Retrieve the current user’s profile, including details such as name, email, and other personal data.GET /api/users/my_preferences/
Retrieve the current user’s dietary preferences for tailoring food and recipe recommendations.
Food Item APIs
The Food Item APIs are at the heart of Santry’s inventory management system. These endpoints allow users to add, update, delete, and retrieve food items, ensuring efficient tracking of their pantry.
GET /api/food-items/
List all food items for the current user, including details like name, quantity, and expiry date.POST /api/food-items/
Create a new food item in the user’s inventory by providing details like its name, quantity, and expiry date.GET /api/food-items/{id}/
Retrieve details of a specific food item based on its ID.PUT /api/food-items/{id}/
Update the details of a specific food item.DELETE /api/food-items/{id}/
Remove a specific food item from the user’s inventory.GET /api/food-items/expiring_soon/
List all food items that are expiring within the next three days. This endpoint helps users avoid food waste by identifying perishable items.
Recipe APIs
The Recipe APIs provide tools for managing recipes, empowering users to create, view, and update personalized recipes based on their preferences and available ingredients.
GET /api/recipes/
List all recipes for the current user.POST /api/recipes/
Create a new recipe by providing details like the recipe title, ingredients, and instructions.GET /api/recipes/{id}/
Retrieve details of a specific recipe, including ingredients and cooking instructions.PUT /api/recipes/{id}/
Update the details of a specific recipe.DELETE /api/recipes/{id}/
Delete a specific recipe from the user’s collection.
Notification APIs
The Notification APIs are designed to keep users informed about important updates, such as food expiration alerts, recipe suggestions, and system notifications. These endpoints allow for both managing and retrieving notifications.
GET /api/notifications/
List all notifications for the current user.POST /api/notifications/
Create a new notification manually (useful for custom alerts).GET /api/notifications/{id}/
Retrieve details of a specific notification.PUT /api/notifications/{id}/
Update the details of a specific notification.DELETE /api/notifications/{id}/
Delete a specific notification.POST /api/notifications/mark_all_read/
Mark all notifications as read, enabling users to clear their notification list in one go.
Category APIs (Read-Only)
The Category APIs provide read-only access to predefined categories, which can help users organize their food items and recipes more effectively.
GET /api/categories/
List all available categories, such as “Dairy,” “Vegetables,” or “Grains.”GET /api/categories/{id}/
Retrieve details of a specific category.
Dietary Preference APIs (Read-Only)
The Dietary Preference APIs offer read-only access to predefined dietary preferences, enabling developers to tailor recipe suggestions and food recommendations.
GET /api/dietary-preferences/
List all available dietary preferences, such as “Vegan,” “Keto,” or “Gluten-Free.”GET /api/dietary-preferences/{id}/
Retrieve details of a specific dietary preference.
How These APIs Work Together
The Santry API is designed to provide a seamless experience for managing food and recipes. Here’s an example workflow that demonstrates how these APIs work together:
- User Profile and Preferences:
Start by retrieving the user’s profile (GET /api/users/me/) and dietary preferences (GET /api/users/my_preferences/) to personalize the experience. - Food Inventory Management:
Use the Food Item APIs to add food items (POST /api/food-items/), monitor expiring items (GET /api/food-items/expiring_soon/), and update inventory as needed (PUT /api/food-items/{id}/). - Recipe Suggestions:
Leverage the Recipe APIs to create recipes (POST /api/recipes/) based on available ingredients and dietary preferences. - Notifications:
Keep users informed about expiring food or new recipe suggestions using the Notification APIs (GET /api/notifications/). - Categories and Dietary Preferences:
Use the Category and Dietary Preference APIs to enhance organization and filtering, ensuring users can easily find what they need.