965
edits
Changes
Jump to navigation
Jump to search
mLine 4:
Line 4: − '''🚀 [https://documenter.getpostman.com/view/8470508/SVtN3Wzy https://documenter.getpostman.com/view/8470508/SVtN3Wzy] 🚀'''+ + Line 41:
Line 42: − + Line 70:
Line 71: + + Line 75:
Line 78: − + − + + Line 86:
Line 90: − +
Reverted edits by Charlesnepote (talk) to last revision by Teolemon
The new version of the documentation is available here:
The new version of the documentation is available here:
* [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.
* 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: MyFoodApp - Android - Version 1.0 - https://myfoodapp.example.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: CoolFoodApp - Android - Version 1.0 - https://coolfoodapp.com</code>)
== WRITE operations ==
== WRITE operations ==
== SDKs ==
== SDKs ==
We have projects to create SDKs for major platforms. If you'd like to help out, [https://slack.openfoodfacts.org please join the dedicated Slack discussion channels] or open an issue on the existing repository.
We have projects to create SDKs for major platforms. If you'd like to help out, [https://slack.openfoodfacts.org please join the dedicated Slack discussion channels] or open an issue on the existing repository.
It is important that SDK support both read and write operations, and evolve with the API.
* [[API/Android|Android SDK]] - The official app used to be coded in Java and is now in Kotlin. Extraction into a reusable library would be welcome.
* [[API/Android|Android SDK]] - The official app used to be coded in Java and is now in Kotlin. Extraction into a reusable library would be welcome.
* [[API/Go|Go SDK]] - https://github.com/openfoodfacts/openfoodfacts-go
* [[API/Go|Go SDK]] - https://github.com/openfoodfacts/openfoodfacts-go
* [[API/Java|Java SDK]] - The official app used to be coded in Java. Extraction into a Java library would be welcome.
* [[API/Java|Java SDK]] - The official app used to be coded in Java. Extraction into a Java library would be welcome.
* [[API/Javascript|JavaScript SDK]]
* [[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]]
* [[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!