Line 4: |
Line 4: |
| | | |
| The new version of the documentation is available here: | | The new version of the documentation is available here: |
− | '''🚀 [https://documenter.getpostman.com/view/8470508/SVtN3Wzy https://documenter.getpostman.com/view/8470508/SVtN3Wzy] 🚀'''
| + | * [https://world.openfoodfacts.org/files/api-documentation.html Documentation as HTML on Open Food Facts' servers] |
| + | * [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 41: |
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 79: |
Line 80: |
| * [[API/Javascript|JavaScript SDK]] - We don't have a vanilla Javascript SDK right now | | * [[API/Javascript|JavaScript SDK]] - We don't have a vanilla Javascript SDK right now |
| * Dart - https://github.com/openfoodfacts/openfoodfacts-dart | | * Dart - https://github.com/openfoodfacts/openfoodfacts-dart |
− | * Flutter (official app- - https://github.com/openfoodfacts/smooth-app | + | * Flutter (official app) - https://github.com/openfoodfacts/smooth-app |
| + | * Kotlin (official app) - https://github.com/openfoodfacts/openfoodfacts-androidapp - The official app has recently been Kotlinized. (Help to turn it into a reusable library would be welcome) |
| * Laravel package - https://github.com/openfoodfacts/openfoodfacts-laravel | | * Laravel package - https://github.com/openfoodfacts/openfoodfacts-laravel |
| * [[API/Javascript/NodeJS|NodeJS SDK]] | | * [[API/Javascript/NodeJS|NodeJS SDK]] |
Line 88: |
Line 90: |
| * [[API/Ruby|Ruby SDK]] - https://github.com/openfoodfacts/openfoodfacts-ruby OR gem install openfoodfacts - https://github.com/openfoodfacts/openbeautyfacts-ruby OR gem install openbeautyfacts | | * [[API/Ruby|Ruby SDK]] - https://github.com/openfoodfacts/openfoodfacts-ruby OR gem install openfoodfacts - https://github.com/openfoodfacts/openbeautyfacts-ruby OR gem install openbeautyfacts |
| * [[API/Scala|Scala SDK]] | | * [[API/Scala|Scala SDK]] |
− | * [[API/Swift|Swift SDK]] - The official app is coded in Swift. Extraction into a Swift library would be welcome. | + | * [[API/Swift|Swift SDK]] - The official app is coded in Swift. https://github.com/openfoodfacts/openfoodfacts-ios Extraction into a Swift library would be welcome. |
| Please help us bring Open Food Facts to your favorite language by contributing to SDK! | | Please help us bring Open Food Facts to your favorite language by contributing to SDK! |
| | | |
Line 113: |
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 === |