> For the complete documentation index, see [llms.txt](https://ouvretaferme.gitbook.io/ouvretaferme/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ouvretaferme.gitbook.io/ouvretaferme/readme.md).

# Introduction

{% hint style="warning" %}
**Bêta.** L'API et cette documentation sont en cours de construction et peuvent changer sans préavis.
{% endhint %}

Cette documentation s'adresse aux développeurs qui appellent l'API de Ouvretaferme, pour leur propre structure (script, intégration interne) ou depuis une application tierce qui agit pour le compte d'une structure.

## Par où commencer

La première chose à mettre en place, quelle que soit la route visée ensuite, est l'**authentification** :

* [Vue d'ensemble des modes d'authentification](/ouvretaferme/authentification/authentication.md)
* [Créer et utiliser une clé API personnelle](/ouvretaferme/authentification/personal-access-tokens.md), le point de départ de la plupart des usages
* [OAuth2, pour les applications tierces](/ouvretaferme/authentification/oauth2.md)

Avant d'écrire une boucle d'appels, lisez aussi [Limites et journal des appels](/ouvretaferme/utilisation/limits.md).

## Adresse de l'API

Toutes les routes se trouvent sous une adresse qui porte la version de l'API :

```
https://api.ouvretaferme.org/0.1beta
```

Les requêtes s'effectuent en HTTPS. Les corps de requête et les réponses sont en JSON, à l'exception de quelques routes qui rendent un fichier (une facture en PDF, par exemple), signalées dans la référence.

## Lecture et écriture

Pendant la bêta, l'API est ouverte en lecture aux structures qui ont l'abonnement requis. L'écriture (création, modification, suppression et actions) n'est ouverte qu'aux structures qui participent à la bêta : ailleurs, ces routes répondent `403` avec le code `scope_not_open`.

Une structure de type AMAP n'a pas accès à l'API.