Attestations de covoiturage

Génération d'attestations pour les utilisateurs de services de covoiturage
Attestation sur l'honneur
Cette page concerne les attestations fournies par les opérateurs de covoiturage.
Rendez-vous sur https://attestation.covoiturage.beta.gouv.fr/ pour générer votre attestation sur l'honneur.
Cette fonctionnalité est en cours de développement.
En tant qu'opérateur de covoiturage, contactez nous si vous souhaitez y participer : [email protected]

Merci de créer des tickets si vous rencontrez des problèmes.
Statut de développement des fonctionnalités 
Génération de l'attestation par l'opérateur ;
Téléchargement d'un PDF ;
Page de vérification de l'attestation en ligne (accès public) ;
Envoi de meta-données pour injecter les données personnelles du covoitureur ;
Upload du logo de l'opérateur dans son profil.
Création de l’attestation
La requête est faite par le serveur de l’opérateur et authentifiée avec un token applicatif dans les headers (même token que pour envoyer des preuves).
Chaque appel crée un nouveau certificat même si les paramètres sont exactement les mêmes, les valeurs calculées ont pu changer entre deux appels.
POST /v2/certificates
Authorization: Bearer ${application_token}
​
Request {
    // Paramètres obligatoires
    
    // const tz = Intl.DateTimeFormat().resolvedOptions().timeZone
    "tz": "Europe/Paris",
    "identity": {
        "phone": "+33612345678"
        // OU
        "phone_trunc": "+336123456",
        "operator_user_id": "1111-222-333-4444"
    },
    
    // Paramètres optionnels
    "start_at": "2019-01-01T00:00:00Z",
    "end_at": "2019-12-31T23:59:59Z",
    // départ et arrivée par exemple.
    // Radius de 1km. Maximum 2 positions
    "positions": [{
        "lon": -0.557483,
        "lat": 47.682821
    }, {
        "lon": -0.952637,
        "lat": 47.452236
    }],
}
​
Response [201 Created] {
    "uuid": "8a9d2da9-39e3-4db7-be8e-12b4d2179fda",
    "created_at": "2020-01-01T00:00:00+0100",
​
    // données calculées pour l'attestation
    // peut permettre de faire un retour visuel à l'usager
    // sans avoir à télécharger le PDF.
    "meta": {
        "tz": "Europe/Paris",
        "rows": [
            {
                "index": 0,
                "month": "Juin 2020",
                "trips": 27,
                "distance": 147,
                "remaining": 0
            },
            ...
        ],
        "total_km": 0,         // distance
        "total_rm": 14.283,    // reste à charge
        "total_tr": 119,       // nb de trajets
        "total_point": 0       // nb de points
    }
}
​
Response [204 No Content] {
    "code": 204,
    "error": "No carpools for this period"
}
​
// invalid application_token
Response [401 Unauthorized] {
    "code": 401,
    "error": "Unauthorized"
}
​
// missing permission in the application_token scope
Response [403 Forbidden] {
    "code": 403,
    "error": "Forbidden"
}
​
Response [404 Not Found] {
    "code": 404,
    "error": "Not Found"
}
Télécharger une attestation
Une fois l’attestation créée en base (201 created), on peut télécharger un PDF en y ajoutant des données permettant une identification simplifiée de la personne.
Ces données ne sont pas stockées sur nos serveurs, elles sont ajoutées au document généré à la volée.
POST /v2/certificates/pdf
Authorization: Bearer ${application_token}
​
Request {
    "uuid": "8a9d2da9-39e3-4db7-be8e-12b4d2179fda",
    // personnalisation optionnelle de l'en-tête
    // omettre 'meta' si pas de personnalisation
    // toutes les propriétés sont facultatives
    "meta": {
        "operator": {
            // zone de texte. Maximum de 305 caractères
            // Maximum de 6 lignes séparées par \n
            "content": "..."
        },
        "identity": {
            // Nom de la personne. Maximum de 26 caractères
            "name": "...",
            // zone de texte. Maximum de 305 caractères
            // Maximum de 6 lignes séparées par \n
            "content": "..."
        },
        // zone de texte. Maximum de 440 caractères
        // retour à la ligne auto.
        "notes": "..."
    }
}
​
Response [200 OK] { Buffer... }
​
Response [401 Unauthorized] {
    "code": 401,
    "error": "Unauthorized"
}
​
Response [404 Not Found] {
    "code": 404,
    "error": "Not Found"
}
Ci-dessous l'attestation avec les méta-données ajoutées au PDF.
operator.content en zone A
identity.name en zone B
identity.content en zone C
notes en zone D
Invalider un trajet
Suivant - ⚙️Opérateurs
Documentation technique
Dernière mise à jour 1 month ago