Jump to content

Open Food Facts API Version 2: Difference between revisions

no edit summary
No edit summary
Line 30: Line 30:
= Generic requirements =
= Generic requirements =
These requirements are valid for all OFF-API's, whether read or write.
These requirements are valid for all OFF-API's, whether read or write.
== Field names ==
For the naming of the fields of the results json the following principles are used:
* Typing - the to expected type of the values is encoded in the field names, by a string at the end:
** _tags - expect a String array;
** _n - expect an Integer;
** _t - expect a time in seconds since 1970, encoded as Integer;
** _f - expect a float;
** none - the default will be a String


== Multilingual support ==
== Multilingual support ==
Line 55: Line 64:
This is also valid for fields that will be in the interface language, as a translation is not always available.
This is also valid for fields that will be in the interface language, as a translation is not always available.


== Nutritional values ==
= Product read API =
= Product read API =


Line 61: Line 71:
== result json ==
== result json ==


=== field names ===
For the naming of the fields of the results json the following principles are used:
* Typing - the to expected type of the values is encoded in the field names, by a string at the end:
** _tags - expect a String array;
** _n - expect an Integer;
** _t - expect a time in seconds since ?, encoded as Integer;
** _f - expect a float;
** none - the default will b a String


=== platform specific naming issues ===
=== platform specific naming issues ===
3,543

edits