LabelAPI - FAQ
What are Sessions (sid) and why are they important to building an app with Food Essentials API?
What are Dietary Profiles and why are they important to building an app with Food Essentials API?
What is Product Score and why is it core to building an app with Food Essentials API?
How do I display the serving/portion size?
What if I just want to show a product's nutrients?
What if I just want to show a product's ingredients?
How do I show a product's allergen status?
What are Food Lists and why are they important to building an app with Food Essentials API?
What is uid/uuid?
What is devid and how do i get one?
What is appid and how do i get one?
How many US products are in your database?
Is is required to use your SDK? Are just direct requests to API allowed?
How up to date is your database?
What requirements need to be met in order to subscribe to the Premium API plan?
Can the Premium API plan be used for both paid and free apps?
Is there a live demo I can play with?
Sessions have been put in place to provide the infrastructure for future product recommendation functionality. In order to make accurate and personalized product recommendations to help users find healthier products we need to record actions to a session.
The FoodEssentials Personalized Dietary Profile is key and core to the FoodEssentials API. All the product data that is returned via a call is customized in the profile. The profile stores what nutrients, additives, allergens, and ingredients you care about. It also stores which property is used to sort returned product data, and to base personalized recommendations on. Use the Set Profile (setprofile) and Add My Ingredient (addmyingredient) methods to update and customize your profile. Use the Get Profile (getprofile) method to retrieve your existing profile as a JSON or XML string. If one has not been set already, getprofile will provide a default profile.
There is a detailed walk-through of the profile on our Set Profile page.
The FoodEssentials Personalized Product Score (PPS) delivers a product score for a given product based on what an individual considers important. The PPS is designed to provide a specific user with a reference to compare products and product appropriateness to their specific needs. The Personalized Product Score therefore cannot be used to determine or rate the nutritive values of products. It only reflects the appropriateness of a product based on their FoodEssentials Personalized Dietary Profile
The Product Score method (productscore) will return a product score number from -100 to 100 for a given UPC based on a user’s dietary profile settings. Use this to rate or compare any array of products based on the dietary profile. but can be used by developers to display results in any other related visual or alpha numeric scale.
There is a detailed walk-through of the Product Score method (productscore) on our Product Score page.
The Label Array method (labelarray) will return the serving size, serving size unit of measurement e.g. "g" or "cup", and the servings per container. See our written documentation for labelarray to this and more of what product details labelarray returns.
The Label Array method (labelarray) and the Product Score method (productscore) are used to return the main details of a given product and it's nutritive data.
There is a detailed walk-through showing a product's nutrients on our Showing Nutrients page.
The Label method (label) is used to return the ingredient list of a given product.
Details for the label method can be found on our Written Documentation page.
The Get Allergen Additive method (getallergenadditive) is used to return the allergen status of a given product.
Details for the Get Allergen Additive method can be found on our Allergen Status page.
'My List' is provided as a feature for users to create and save products to a shopping list. This can be used either as an actual shopping list, or as a historic product list, or as any other incarnation of a product list that developers would like.
Wikipedia can explain the nerdity of it best. It's purpose is to uniquely identify each user. You can use any alpha string but you want make sure that you use something that will be different for every user of your app. This is especially important if your app allows multiple users on the same device or if you want to be sure a user can retrieve their data from another device.
devid is the device ID. You can get it from android.provider.Settings.System.ANDROID_ID for Android Apps. For iPhone, refer to this doc. You can use any alpha string but you want to make sure that you use something that will be different for every installation of your app. This is especially important if your app allows for the same user to use multiple devices.
Getting an appid is easy. You just need to register. (see: GET STARTED)
Our database represents 90-95% of the products sold (sales) in the U.S. market. This is pretty much standard with all the leading databases. This does not however mean that this represents the percentage of products in the UN market as there are many specialty products that are not at this time represented in the database. The result is that for a typical national retailer we may have up to 90% of their products, but for specialty stores we could have less than 50% of their products.
To counter this we offer the data collection SDK (beta). This is a data collection API which provides your users the ability to collect photos of products that are not in the database with our commitment being to digitize and make available that data as soon as possible. We have found that users get excited to contribute to the database and that their involvement in the database maintenance builds loyalty to the application.
We highly recommend the SDK as a solution and developers are having great results. It is still in beta so it is not a requirement but we have found it to increase engagement for apps that implement it. Sole use of direct requests to the API allowed.
We have the most up-to-date, accurate, and powerful database in the industry. We process up to 40,000 new or updated products every month and 90% of our products were updated in the last 12 months.
There are no requirements. Our aim is to make the data available to the community and cover administrative and maintenance costs. Our main business is working directly with Government, Retailers, and Food Manufacturers.
Yes, provided they are essentially the same application (same name, just a free and paid version). The one monthly fee covers use of the API for both versions of your application.
Yes! Feel free to play with our in-house Demo Mobile Application to see what might be possible.