# Registre de preuve de covoiturage - Documentation technique

OpenAPI file: https://tech.covoiturage.beta.gouv.fr/source.yaml

## Description

This is version `3.4` of this API documentation. Last update on Sep 7, 2026.
## Le produit

Le Registre de preuve de covoiturage est un service public numérique
développé par le Ministère de l'Écologie et l'Agence de la transition
écologique (ADEME). Il fait partie de l'incubateur des Startups d'État :
la communauté [beta.gouv.fr](https://beta.gouv.fr/)

## A qui s'adresse cette documentation ?

Cette documentation technique est destinée aux personnes :

- souhaitant comprendre l'organisation globale de l'application ;
- souhaitant installer, exécuter, tester, modifier le code ;
- souhaitant soumettre des correctifs ou des améliorations ;
- souhaitant comprendre les méthodes de calcul utilisées pour les incitations ;
- souhaitant effectuer des tests de sécurité sur l'application ;
- ...

sinon, la [documentation générale du produit](https://doc.covoiturage.beta.gouv.fr/) est peut-être pour vous.

## Écosystème

Plusieurs services sont gérés par l'équipe du Registre de preuve de covoiturage :

- [L'observatoire national du covoiturage](https://observatoire.covoiturage.gouv.fr/) permet de suivre l'évolution des pratiques du covoiturage courte distance.
- [Le site vitrine](https://covoiturage.beta.gouv.fr/) présente le produit ;
- [La documentation générale](https://doc.covoiturage.beta.gouv.fr/) ;
- [Espace partenaire](https://partenaire.covoiturage.beta.gouv.fr/) permet aux opérateurs et aux territoires de gérer les campagnes ;
- [Les statistiques](https://observatoire.covoiturage.gouv.fr/startup-etat/stats/) des chiffres clés de la Startup d'État ;
- [Le statut des applications](https://status.covoiturage.beta.gouv.fr/) pour suivre les incidents et l'accessibilité des services ;
- [Le générateur d'attestations sur l'honneur](https://attestation.covoiturage.beta.gouv.fr/) permet aux personnes qui covoiturent de produire facilement un document pour leur employeur dans le but de profiter du Forfait Mobilités Durables.

## Langues

Cette documentation est principalement rédigée en français afin d'éviter
de traduire des termes précis du langage administratif. Les parties
relatives au code de l'application peuvent être en anglais.

## Édition

Le code source de l'application est ouvert. Vous pouvez soumettre des
corrections ou des propositions d'évolution. Pour cela, vous devez avoir
un compte sur la plateforme [Github](https://github.com/).

## Code source

Le code source de l'application est ouvert et disponible sur
[Github](https://github.com/covoiturage-gouv-fr/mono/).

## Environnements

| Environnement | API | Espace partenaire |
| ------------- | --- | ----------------- |
| Production    | https://api.covoiturage.beta.gouv.fr/v3.4 | https://partenaire.covoiturage.beta.gouv.fr/ |
| Demo | https://api.demo.covoiturage.beta.gouv.fr/v3.4 | https://dashboard.demo.covoiturage.beta.gouv.fr/ |

> La version applicative de l'environnement de _demo_ est identique à celle de la _production_.

## Licence et version


## Servers

- Production: https://api.covoiturage.beta.gouv.fr/v3.4 (Production)

- Demo: https://api.demo.covoiturage.beta.gouv.fr/v3.4 (Demo)


## Topics

### [Authentication](https://tech.covoiturage.beta.gouv.fr/authentication.md)

### [Définitions](https://tech.covoiturage.beta.gouv.fr/topic/topic-definitions.md)

### [Connexion à l'API](https://tech.covoiturage.beta.gouv.fr/topic/topic-connexion-a-l-api.md)

### [Rate limiting](https://tech.covoiturage.beta.gouv.fr/topic/topic-rate-limiting.md)

### [Export de trajets](https://tech.covoiturage.beta.gouv.fr/topic/topic-export-de-trajets.md)

### [Open data](https://tech.covoiturage.beta.gouv.fr/topic/topic-open-data.md)

### [Schémas des requêtes HTTP](https://tech.covoiturage.beta.gouv.fr/topic/topic-schemas-des-requetes-http.md)


## Endpoints

### [Authentification](https://tech.covoiturage.beta.gouv.fr/group/endpoint-authentification.md)

- [Créer un jeton d'accès à partir des clés d'API](https://tech.covoiturage.beta.gouv.fr/operation/operation-auth-access_token.md)

- [Lister les clés d'API de l'opérateur](https://tech.covoiturage.beta.gouv.fr/operation/operation-auth-readcredentials.md)

- [Créer une clé d'API pour l'opérateur](https://tech.covoiturage.beta.gouv.fr/operation/operation-auth-createcredentials.md)

- [Supprimer une clé d'API de l'opérateur](https://tech.covoiturage.beta.gouv.fr/operation/operation-auth-deletecredentials.md)


### [Trajets courte distance](https://tech.covoiturage.beta.gouv.fr/group/endpoint-trajets-courte-distance.md)

- [Liste des trajets](https://tech.covoiturage.beta.gouv.fr/operation/operation-get-journeys.md)

- [Envoyer un trajet](https://tech.covoiturage.beta.gouv.fr/operation/operation-acquisition-create.md)

- [Vérifier le statut d'un trajet envoyé](https://tech.covoiturage.beta.gouv.fr/operation/operation-acquisition-status.md)

- [Mettre à jour un trajet](https://tech.covoiturage.beta.gouv.fr/operation/operation-acquisition-update.md)

- [Invalider un trajet envoyé](https://tech.covoiturage.beta.gouv.fr/operation/operation-acquisition-cancel.md)


### [Export de trajets](https://tech.covoiturage.beta.gouv.fr/group/endpoint-export-de-trajets.md)

- [Exporter des trajets](https://tech.covoiturage.beta.gouv.fr/operation/operation-export-createversionthree.md)


### [Géographie](https://tech.covoiturage.beta.gouv.fr/group/endpoint-geographie.md)

- [Calcul théorique de la distance et de la durée](https://tech.covoiturage.beta.gouv.fr/operation/operation-get-geo-route.md)

- [Geocoding à partir d'une adresse litérale](https://tech.covoiturage.beta.gouv.fr/operation/operation-get-geo-point-by_address.md)

- [Geocoding à partir d'un code INSEE](https://tech.covoiturage.beta.gouv.fr/operation/operation-get-geo-point-by_insee.md)




[Powered by Bump.sh](https://bump.sh)
