#Documentation This is the documentation for the partner endpoint of the BigOven Recipe and Grocery List API. The update brings with it Swagger-based documentation. [Swagger](http://swagger.io) is an emerging standard for describing REST-based APIs, and with this Swagger-compliant endpoint (ab
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api2.bigoven.com
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
#Documentation This is the documentation for the partner endpoint of the BigOven Recipe and Grocery List API. The update brings with it Swagger-based documentation. [Swagger](http://swagger.io) is an emerging standard for describing REST-based APIs, and with this Swagger-compliant endpoint (above), you can make ready-to-go interface libraries for your code via [swagger-codegen](https://githu
| method | path | what the vendor says it does |
|---|---|---|
GET | /collection/{id} | Gets a recipe collection. A recipe collection is a curated set of recipes. Collection |
GET | /collection/{id}/meta | Gets a recipe collection metadata. A recipe collection is a curated set of recipes. Collection |
GET | /collections | Get the list of current, seasonal recipe collections. From here, you can use the /collection/{id} endpoint to |
GET | /grocerylist | Get the user's grocery list. User is determined by Basic Authentication. GroceryList |
DELETE | /grocerylist | Delete all the items on a grocery list; faster operation than a sync with deleted items. GroceryList |
POST | /grocerylist/clearcheckedlines | Clears the checked lines. GroceryList |
POST | /grocerylist/department | Departmentalize a list of strings -- used for ad-hoc grocery list item addition GroceryList |
POST | /grocerylist/item | Add a single line item to the grocery list GroceryList |
PUT | /grocerylist/item/{guid} | Update a grocery item by GUID GroceryList |
DELETE | /grocerylist/item/{guid} | /grocerylist/item/{guid} DELETE will delete this item assuming you own it. GroceryList |
POST | /grocerylist/line | Add a single line item to the grocery list GroceryList |
POST | /grocerylist/recipe | Add a Recipe to the grocery list. In the request data, pass in recipeId, scale (scale=1.0 says to keep the re |
POST | /grocerylist/sync | Synchronize the grocery list. Call this with a POST to /grocerylist/sync GroceryList |
POST | /image/avatar | POST: /image/avatar Testing with Postman (validated 11/20/2015): 1) R |
GET | /me | Indexes this instance. Me |
PUT | /me | Puts me. Me |
PUT | /me/personal | Puts me personal. Me |
PUT | /me/preferences | Puts me preferences. Me |
GET | /me/preferences/options | Gets the options. Me |
PUT | /me/profile | Puts me. Me |
GET | /me/skinny | Skinnies this instance. Me |
POST | /recipe | Add a new recipe Recipe |
PUT | /recipe | Update a recipe Recipe |
GET | /recipe/autocomplete | Given a query, return recipe titles starting with query. Query must be at least 3 chars in length. Recipe |
GET | /recipe/autocomplete/all | Automatics the complete all recipes. Recipe |
GET | /recipe/autocomplete/mine | Automatics the complete my recipes. Recipe |
GET | /recipe/categories | Get a list of recipe categories (the ID field can be used for include_cat in search parameters) Recipe |
GET | /recipe/get/active/recipe | Returns last active recipe for the user Recipe |
POST | /recipe/get/saved/step | Gets recipe single step as text Recipe |
POST | /recipe/get/step/number | Returns stored step number and number of steps in recipe Recipe |
GET | /recipe/photos/pending | Gets the pending by user. Images |
POST | /recipe/post/step | Stores recipe step number and returns saved step data Recipe |
PUT | /recipe/review/replies/{replyId} | Update (PUT) a reply to a given review. Authenticated user must be the original one that posted the reply. Rev |
DELETE | /recipe/review/replies/{replyId} | DELETE a reply to a given review. Authenticated user must be the one who originally posted the reply. Review |
GET | /recipe/review/{reviewId} | Get a given review by string-style ID. This will return a payload with FeaturedReply, ReplyCount. |
PUT | /recipe/review/{reviewId} | Update a given top-level review. Review |
GET | /recipe/review/{reviewId}/replies | Get a paged list of replies for a given review. Review |
POST | /recipe/review/{reviewId}/replies | POST a reply to a given review. The date will be set by server. Note that replies no longer have star ratings, |
POST | /recipe/scan | POST an image as a new RecipeScan request 1) Fetch the filename -- DONE 2) |
GET | /recipe/steps/{id} | Return full Recipe detail with steps. Returns 403 if the recipe is owned by someone else. Recipe |
and 26 more operation(s) in this specification, all searchable.
specification origin: http://api2.bigoven.com/swagger/docs/partner
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.