Partage d’un document personnel

Il existe deux possibilités de partage de documents personnels :

• le partage nominatif : la personne pourra alors voir le document dans sa liste et le télécharger
• le partage public : une URL aléatoire permet alors à n’importe qui de télécharger le fichier

Le partage nominatif #

Il est nécessaire de disposer des identifiants des utilisateurs avec lesquels on souhaite partager le document.

Le partage d’un document personnel avec d’autres utilisateurs s’effectue à l’aide de l’appel suivant :

https://data.geopf.fr/api/users/me/documents/{document}/sharings

[
    "{compte 1}",
    "{compte 2}"
]

{
    "name": "Mon super croquis",
    "description": "Un petit coucou géoréférencé à l’IGN",
    "size": 5435,
    "mime_type": "application/octet-stream",
    "labels": [
        "tutoriels",
        "croquis"
    ],
    "_id": "{document}"
}

Désormais, les comptes ciblés pourront voir le document dans leur liste avec l’appel :

https://data.geopf.fr/api/users/me/documents

Et ces comptes pourront télécharger le fichier via l’API Entrepôt (https://data.geopf.fr/api/users/me/documents/{document}/file, la même URL qu’avec le compte propriétaire). Ce partage implique d’être authentifié pour le destinataire (donc d’avoir un compte) et de partager explicitement avec tous les destinataires.

Le partage public #

Ce mode de partage est plus simple mais moins sécurisé. Il consiste à associer au fichier une URL publique qui pourra être consultée anonymement.

https://data.geopf.fr/api/users/me/documents/{document}

{
    "public_url": true
}

{
    "name": "Mon super croquis",
    "description": "Un petit coucou géoréférencé à l’IGN",
    "size": 5435,
    "mime_type": "application/octet-stream",
    "labels": [
        "tutoriels",
        "croquis"
    ],
    "public_url": "https://data.geopf.fr/documents/89476dA1gBOOJWU9yXp8QcpZwnTt4ICxlhWtIIQHPbMGLo.bin",
    "_id": "{document}"
}

Une URL publique a été générée aléatoirement, une extension en accord avec le type de fichier a été mise. Il est possible de supprimer cet accès public en précisant "public_url": false. À chaque partage public, l’URL sera différente.