mirror of
https://github.com/openfoodfoundation/openfoodnetwork
synced 2026-02-17 00:07:24 +00:00
Data Food Consortium API for the Open Food Network app (OFN DFC API)
This engine implements the Data Food Consortium specifications. It serves and reads semantic data encoded in JSON-LD.
Authentication
The DFC uses OpenID Connect (OIDC) to authenticate requests. You need an account with a trusted OIDC provider. Currently these are:
But you can also authenticate with your OFN user login (session cookie) through your browser.
API endpoints
The API is under development and this list may be out of date.
/api/dfc-v1.7/persons/:id
* show: firstName, lastName, affiliatedOrganizations
/api/dfc-v1.7/enterprises/:id
* show: name, suppliedProducts, catalogItems
/api/dfc-v1.7/enterprises/:enterprise_id/supplied_products (index)
/api/dfc-v1.7/enterprises/:enterprise_id/supplied_products/:id
* create: name, description, quantity
* show: name, description, productType, quantity
* update: description
/api/dfc-v1.7/enterprises/:enterprise_id/catalog_items (index)
/api/dfc-v1.7/enterprises/:enterprise_id/catalog_items/:id
* show: product, sku, stockLimitation, offers (price, stockLimitation)
* update: sku, stockLimitation