Changes

Jump to navigation Jump to search
211 bytes added ,  08:47, 15 May 2021
Line 4: Line 4:     
The new version of the documentation is available here:  
 
The new version of the documentation is available here:  
[[Documentation as HTML on Open Food Facts' servers|https://world.openfoodfacts.org/files/api-documentation.html]]
+
* [https://world.openfoodfacts.org/files/api-documentation.html Documentation as HTML on Open Food Facts' servers]
[[Documentation on Postman|https://documenter.getpostman.com/view/8470508/SVtN3Wzy]] (might be slow)
+
* [https://documenter.getpostman.com/view/8470508/SVtN3Wzy Documentation on Postman] (might be slow)
    
We have many SDKs at the bottom of the page, and we also have official implementations for Android, iPhone (and Flutter) that you can draw inspiration from.
 
We have many SDKs at the bottom of the page, and we also have official implementations for Android, iPhone (and Flutter) that you can draw inspiration from.
Line 42: Line 42:  
* You can do READ operations using the production server.
 
* You can do READ operations using the production server.
 
* You should use the SSL version of the API. <code>https://world.openfoodfacts.org</code>
 
* You should use the SSL version of the API. <code>https://world.openfoodfacts.org</code>
* '''Please send a UserAgent HTTP Header''' with the name of the app/service querying, the version, system and a URL if you have one, so that you are not blocked by mistake (e.g. <code>UserAgent: CoolFoodApp - Android - Version 1.0 - https://coolfoodapp.com</code>)
+
* '''Please send a UserAgent HTTP Header''' with the name of the app/service querying, the version, system and a URL if you have one, so that you are not blocked by mistake (e.g. <code>UserAgent: MyFoodApp - Android - Version 1.0 - https://myfoodapp.example.com</code>)
    
== WRITE operations ==
 
== WRITE operations ==
Line 115: Line 115:     
You can fill in the issue report [https://github.com/openfoodfacts/openfoodfacts-server/issues/new here on GitHub]
 
You can fill in the issue report [https://github.com/openfoodfacts/openfoodfacts-server/issues/new here on GitHub]
 +
(For documentation issues, see below)
 +
=== Keeping the documentation up to date with the live API ===
 +
* Project that tracks what we have to document: https://github.com/openfoodfacts/api-documentation/issues
    
=== Known bugs ===
 
=== Known bugs ===

Navigation menu