Line 18: |
Line 18: |
| <pre>https://ssl-api.openfoodfacts.org</pre> | | <pre>https://ssl-api.openfoodfacts.org</pre> |
| ==== WRITE operations ==== | | ==== WRITE operations ==== |
| + | |
| + | ===== Use cases ===== |
| + | * You can add photos and informations to Open Food Facts using the API. |
| + | ** Letting your users add new products by uploading photos is the most common use case. |
| + | ** Several apps already enable more advanced editing. Gamification would be welcome. |
| + | ** The official mobile apps can use some help. |
| + | |
| + | ===== A few things ===== |
| + | ** Do join the API channel if you intend on using WRITE |
| + | ** Do not send copyrighted photos or information using the API. Everything you send is OdBL for the data, and CC-BY-SA for the pictures. If those are not yours (eg from scraping), you bear all the legal consequences. |
| + | **You can create a global account for your app if you don't want to implement Open Food Facts user creation in your app right now. Please report it in #api so that it can be monitored for errors. |
| * You should do all your test edits on http://world.openfoodfacts.net (ask for the password on Slack) | | * You should do all your test edits on http://world.openfoodfacts.net (ask for the password on Slack) |
− | * Do not hesitate to create a global account for your app if you don't want to implement Open Food Facts user creation in your app right now.
| + | |
| === Conventions for the API === | | === Conventions for the API === |
| * fields that end with _t are dates in the UNIX timestamp format (number of seconds since Jan 1st 1970) | | * fields that end with _t are dates in the UNIX timestamp format (number of seconds since Jan 1st 1970) |