{"id":19670087,"url":"https://github.com/openfoodfacts/api-documentation","last_synced_at":"2025-02-27T04:42:32.988Z","repository":{"id":37256771,"uuid":"201616119","full_name":"openfoodfacts/api-documentation","owner":"openfoodfacts","description":"Version 2 of the documentation of the V1 API. The code behind the API is at https://github.com/openfoodfacts/openfoodfacts-server. An effort is made there to create a V3 of the documentation based on OpenAPI","archived":false,"fork":false,"pushed_at":"2024-10-11T00:29:23.000Z","size":86771,"stargazers_count":19,"open_issues_count":40,"forks_count":7,"subscribers_count":14,"default_branch":"develop","last_synced_at":"2024-10-29T22:38:12.108Z","etag":null,"topics":["api","documentation","hacktoberfest","openfoodfacts"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openfoodfacts.png","metadata":{"funding":{"patreon":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"open_collective":"openfoodfacts-server","github":"openfoodfacts","custom":"https://donate.openfoodfacts.org"},"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-08-10T10:39:15.000Z","updated_at":"2024-09-30T17:12:57.000Z","dependencies_parsed_at":"2023-02-10T02:01:33.474Z","dependency_job_id":"bffba09c-7ced-4cc8-97fe-f4713a3c3000","html_url":"https://github.com/openfoodfacts/api-documentation","commit_stats":{"total_commits":214,"total_committers":11,"mean_commits":"19.454545454545453","dds":0.5981308411214954,"last_synced_commit":"5e63ba2f8b454fa8472910ce24fa44095fc0cece"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfoodfacts%2Fapi-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfoodfacts%2Fapi-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfoodfacts%2Fapi-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfoodfacts%2Fapi-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openfoodfacts","download_url":"https://codeload.github.com/openfoodfacts/api-documentation/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240954188,"owners_count":19884135,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","documentation","hacktoberfest","openfoodfacts"],"created_at":"2024-11-11T17:04:03.402Z","updated_at":"2025-02-27T04:42:32.969Z","avatar_url":"https://github.com/openfoodfacts.png","language":null,"funding_links":["https://opencollective.com/openfoodfacts-server","https://github.com/sponsors/openfoodfacts","https://donate.openfoodfacts.org"],"categories":[],"sub_categories":[],"readme":"# API Documentation\n\n## Deprecation notice\n\n**Important**:\nThis documentation is being deprecated in favour of the new OpenAPI documentation (see below)\n\n## Up-to-date Documentation of the Open Food Facts API\n\n* intro: https://openfoodfacts.github.io/openfoodfacts-server/introduction/api/\n* reference: https://openfoodfacts.github.io/openfoodfacts-server/reference/api/ \n* The source: https://github.com/openfoodfacts/openfoodfacts-server/tree/main/docs/reference\n\n## Rendering of this (deprecated) documentation\n\nThe API documentation is rendered here (see above for the more up-to-date documentation):\n\n* Stable version of the doc: https://openfoodfacts.github.io/api-documentation/\n* Staging version of the doc: https://openfoodfacts.github.io/api-documentation-staging/\n\nWe have an older version available on the Wiki.\n\n* https://wiki.openfoodfacts.org/Documentation\n\n## Roadmap\n\nWe need documentation maintainers\n\n* [ ] to document new features (Eco-Score, Attributes…)\n* [ ] to improve existing documents based on feedback and questions in the #api channel\n* [ ] What can I help with ? https://github.com/openfoodfacts/api-documentation/issues/23\n\n## Edit this (deprecated) documentation\n\nRemember that this project is deprecated, you should instead contribute to the OpenAPI documentation.\n\n### Install the Postman application\n\nhttps://www.postman.com/downloads/\n\n### Clone the repository\n\n```\ngit clone https://github.com/openfoodfacts/api-documentation\ngit checkout -b \u003cDOC_FIX_BRANCH_NAME\u003e\n```\n\n### Edit the collection with Postman\n\n* Open Postman\n* Click \"Import\" then \"Folder\" and browse to this repository's folder.\n* Postman collection and environment located in the repo will be imported in your Postman application.\n* Edit the collection using the application, and once you're done click \"Export\"\n* Rename the file as `off-pm-collection.json`\n* Save it (overwrite the original one)\n\n### Push to git\n\nNow it's time to propose your changes as a pull request on the repository. We're going to make a branch and commit our updated `off-pm-collection.json`.\n\nRun:\n\n```\ngit checkout -b \u003cNEW_BRANCH_NAME\u003e\ngit add off-pm-collection.json\ngit commit -m \"\u003cCOMMIT_MESSAGE\u003e\"`\ngit push --set-upstream origin \u003cNEW_BRANCH_NAME\u003e\n```\n\nOnce you are done:\n\n* Open a browser\n* Navigate to https://github.com/openfoodfacts/api-documentation\n* Open a new PR from your branch (\"Create Pull Request\" button).\n* View your updated documentation that was automatically deployed to the staging environment https://openfoodfacts.github.io/api-documentation-staging.\n\n\n## Applications using this API\n\n### Official application\n\nThe official Open Food Facts app uses the API.\n\n### Third party applications\n\nFeel free to open a PR to add your application in this list.\n\n- **Gluten Scan**. [Android](https://play.google.com/store/apps/details?id=com.healthyfood.gluten_free_app) / [iOS](https://apps.apple.com/ch/app/gluten-scanner/id1540660083)\n- **Halal \u0026 Healthy**. [Android](https://play.google.com/store/apps/details?id=com.TagIn.Tech.handh) / [iOS](https://apps.apple.com/ch/app/halal-healthy/id1603051382)\n- **Fitness Tracker**. [Android](https://play.google.com/store/apps/details?id=dk.cepk.fitness_tracker)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenfoodfacts%2Fapi-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenfoodfacts%2Fapi-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenfoodfacts%2Fapi-documentation/lists"}