Télécharger une attestation

POST /certificates/{uuid}/attachment

Cette API sera dépréciée en v3.2 et ne sera pas remplacée.

Upload du logo opérateur

Vous pouvez personnaliser le logo opérateur présent sur l'attestation.

Contrairement aux meta-données envoyées lors de la création de l'attestation, le logo est configuré au préalable via le page de profil de votre opérateur.

Le poids de l'image est de 2Mo maximum et sa taille de 1024x1024 pixels.

Téléchargement

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 meta-données optionnelles ne sont pas stockées sur nos serveurs, elles sont ajoutées au document généré à la volée.

Le PDF généré n'est pas stocké sur nos serveurs. L'appel d'API vous renvoie un fichier binaire que vous sauvegardez de votre côté. Vous pouvez générer le PDF d'une attestation plusieurs fois de suite.

Path parameters

uuid string(uuid) Required

Identifiant de l'attestation précédemment créé.

application/json

Body Required

meta object

personnalisation optionnelle de l'en-tête omettre 'meta' si pas de personnalisation toutes les propriétés sont facultatives

Additional properties are allowed.
Hide meta attributes Show meta attributes object
- operator string
  
  zone de texte. Maximum de 305 caractères Maximum de 6 lignes séparées par \n
  
  Maximum length is 305.
- identity object
  
  Additional properties are allowed.
  Hide identity attributes Show identity attributes object
  
  name string
  
  Nom de la personne
  
  Maximum length is 26.
  
  content string
  
  zone de texte. Maximum de 305 caractères Maximum de 6 lignes séparées par \n
  
  Maximum length is 305.
- note string
  
  zone de texte. Maximum de 440 caractères Retour à la ligne automatique (wrap)

Responses

200

OK, le fichier binaire est envoyé
401 application/json

Non authentifié. Le token applicatif est manquant ou invalide.
403 application/json

Non autorisé
404 application/json

L'attestation n'a pu être trouvée

POST /certificates/{uuid}/attachment

curl \
 -X POST https://api.covoiturage.beta.gouv.fr/v3.1/certificates/{uuid}/attachment \
 -H "Content-Type: application/json" \
 -d '{"meta":{"operator":"string","identity":{"name":"string","content":"string"},"note":"string"}}'

Request examples

{
  "meta": {
    "operator": "string",
    "identity": {
      "name": "string",
      "content": "string"
    },
    "note": "string"
  }
}

Response examples (401)

{
  "id": 1,
  "error": {
    "code": -32501,
    "data": "Unauthorized application",
    "message": "Unauthorized Error"
  },
  "jsonrpc": "2.0"
}

Response examples (403)

{
  "id": 1,
  "error": {
    "code": -32503,
    "data": "Invalid permissions",
    "message": "Forbidden Error"
  },
  "jsonrpc": "2.0"
}

Response examples (404)

{
  "code": 404,
  "error": "Not found"
}