Skip to content

Commit

Permalink
docs: improve API documentation (#9417)
Browse files Browse the repository at this point in the history
  • Loading branch information
raphael0202 authored Nov 27, 2023
1 parent 4db37c4 commit 043bcb3
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ We want to learn what the Open Food Facts data is used for. It is not mandatory,

> Generally, the more information we have about a product, the more we can compute it.
## Rate limits
### Rate limits

To protect our infrastructure, we enforce rate-limits on the API and the website. The following limits apply:

Expand Down Expand Up @@ -71,7 +71,10 @@ While testing your applications, **make all API requests to the staging environm

## Authentication

- READ operations (getting info about a product, etc...) do not require authentication, although we _ask you to use a custom User-Agent_ to identify you if you're developing an application (to not risk being identified as a bot)
We ask you to **always use a custom User-Agent to identify you** (to not risk being identified as a bot). The User-Agent should be in the form of `AppName/Version (ContactEmail)`. For example,
`MyApp/1.0 ([email protected])`.

- READ operations (getting info about a product, etc...) do not require authentication except the custom User-Agent.

- WRITE operations (Editing an Existing Product, Uploading images…) **require authentication**. We do this as another layer of protection against spam.

Expand Down

0 comments on commit 043bcb3

Please sign in to comment.