Alimenter le registre via l'API

Voir Ă©galement Schema JSON.

Envoyer un trajet de covoiturage Ă  l’API du Registre de Preuve de Covoiturage nĂ©cessite que plusieurs critĂšres soient remplis.

  • 1ïžâƒŁ Une entitĂ© “opĂ©rateur de covoiturage” est crĂ©Ă©e sur l’application du registre.

  • 2ïžâƒŁ Un utilisateur appartenant Ă  cet opĂ©rateur de covoiturage est administrateur.

  • 3ïžâƒŁ L’administrateur opĂ©rateur crĂ©e un token applicatif.

  • 4ïžâƒŁ Ce token applicatif est installĂ© sur le serveur de l’opĂ©rateur qui va envoyer les donnĂ©es et sera passĂ© dans le Header de chacune des requĂȘtes.

  • 5ïžâƒŁ Le serveur peut communiquer avec les serveurs suivants :

1ïžâƒŁ 2ïžâƒŁ - AccĂ©der Ă  l’application du registre

Afin de valider les critĂšres 1ïžâƒŁ et 2ïžâƒŁ , veuillez Ă  respecter la procĂ©dure Rejoindre le registre. En effet, ces opĂ©rations sont rĂ©alisĂ©es par un membre de l’équipe du Registre de preuve de covoiturage.

La procédure sera simplifiée et automatisée.

3ïžâƒŁ - CrĂ©er un token applicatif

Cette manipulation est réalisable, uniquement pour les utilisateurs dits administrateurs, sur l'interface applicative du Registre de preuve de covoiturage.

  1. Créer un nouveau token ;

  2. Donner un nom Ă  ce token ;

  3. Copier le token gĂ©nĂ©rĂ© et le conserver de maniĂšre sĂ©curisĂ©e. Il devra ĂȘtre envoyĂ© dans le header de chaque requĂȘte serveur.

Ce token ne pourra pas ĂȘtre rĂ©-affichĂ© ni rĂ©cupĂ©rĂ©. Si le token est perdu, il doit ĂȘtre recrĂ©Ă© par la mĂȘme procĂ©dure.

4ïžâƒŁ 5ïžâƒŁ - Logique de connexion au service

Le token applicatif donnĂ© lors de la crĂ©ation de l’application doit ĂȘtre envoyĂ© dans les Headers des requĂȘtes serveurs comme ceci :

Authorization: Bearer {token}

Seule la route POST /v2/journeys accepte l’authentification avec ce token. Une erreur 401 Unauthorized est retournĂ©e pour les tokens invalides. Un code de retour 201 Created est retournĂ© quand la preuve est acceptĂ©e.

Les tokens n’expirent pas dans le temps mais ils peuvent ĂȘtre mis sur une liste noire en cas d’utilisation anormale.

Limitations du nombre de requĂȘtes

Le nombre de requĂȘtes envoyĂ©es sur la route d'acquisition des preuves est de 20000 par minute. Au delĂ , merci de diffĂ©rer les envois en plusieurs blocs espacĂ©s de quelques minutes. Les autres routes de l'application ont des limites beaucoup plus basses.

Foire Aux Questions

Qu'est-ce qu'un trajet ?

RĂ©ponse : un trajet est un couple passager/conducteur

Dans la base de données les trajets correspondent à des couples passager-conducteur contenant les informations d'un trajet effectué. Ainsi si dans un covoiturage le nombre de passager est de 2 alors deux couples sont envoyés au registre :

  • Conducteur.rice 1 - Passager 1 : 10 km, etc.

  • Conducteur.rice 1 - Passager 2 : 10,5 km, etc.

Quel est le délai d'envoi des preuves de covoiturage ?

RĂ©ponse : 5 jours (120 heures)

Le registre a pour vocation d'agrĂ©ger des preuves de covoiturage notamment dans l’objectif de lutter contre la fraude massive. Cette preuve de covoiturage est constituĂ©e d’un point de dĂ©part et d’arrivĂ©e. En consĂ©quence, il n’est pas possible, aujourd’hui, pour le registre de dĂ©livrer des attestations de covoiturage, pendant un trajet afin d’obtenir une incitation en temps rĂ©el. En revanche, il est indispensable pour les organismes incitateurs d’obtenir des informations sur la rĂ©alisation d’un trajet au plus vite. En consĂ©quence, un juste milieu doit ĂȘtre trouvĂ©.

Le consensus trouvĂ© avec les diffĂ©rentes parties prenantes est un dĂ©lai de 5 jours (120 heures) entre la fin du trajet et la communication de la preuve de covoiturage. Nos processus de contrĂŽle opĂ©rant durant 2 jours (48H00), notre promesse serait “retrouvez dans le registre de preuve de covoiturage, les trajets rĂ©alisĂ©s en maximum une semaine”.

Temporalité du parcours d'une preuve de covoiturage.

Peut-on envoyer des preuves de covoiturage versionnées sur le registre ?

RĂ©ponse : non

A l’heure actuelle, il n’est pas possible de modifier une preuve soumise au registre. C’est une Ă©volution possible que nous Ă©tudions. Nous publierons trĂšs probablement un document sur le sujet avec la base de nos rĂ©flexions et vous inviterons Ă  l’amender avec vos propositions et remarques.

​