16.3 Téléchargement d'une image publique

16.3.1 Url

Téléchargement d'un fichier image contenu dans le répertoire Images ou dans le coffre en accès public.

16.3.1.1 Images enregistrées sur le serveur

Pour les images enregistrées sur le serveur, l'url d'accès est :

• api/v1/images/assets/original/<fileName>

Cette ressource télécharge le fichier image contenu dans le répertoire Images du serveur. Le nom du fichier <fileName> est le chemin relatif du fichier à télécharger. Le chemin est relatif au répertoire Ìmages du serveur. Le chemin ne peut pas contenir ...

Les extensions de fichiers autorisées sont png, jpg, jpeg et gif.

Exemple :

• api/v1/images/assets/original/mime-source_php.png
• api/v1/images/assets/original/flags/fr.png

16.3.1.2 Images publiques enregistrées dans le coffre

Pour les images enregistrées dans le coffre

• api/v1/images/recorded/original/<vaultIdentifier>
• api/v1/images/recorded/original/<vaultIdentifier>.<extension>

Depuis l'interface de consultation d'un document famille, d'un dossier ou d'une recherche, il est possible de modifier l'icône de celle-ci. Dans ce cas, l'image est enregistrée dans le coffre en accès public c'est à dire sans nécessité de vérifier un contrôle sur le document. L'identifiant utilisée doit correspondre à un identifiant d'une image. Si l'identifiant indique un autre type de fichier, le téléchargement ne sera pas autorisé.

L'extension du fichier est facultative. Si elle est présente elle doit correspondre à l'extension du fichier enregistré dans le coffre.

L'identifiant du coffre peut être obtenu par la récupération des informations sur la propriété "icon" du document (ici n°66518).

GET http://localhost/tmp/api/v1/documents/66518?fields=document.properties

Réponse :

{
    "success": true,
    "messages": [],
    "data": {
        "document": {
            "properties": {
                "id": 66518,
                "title": "Les ondes gravitationnelles",
                "icon": "api/v1/images/recorded/sizes/24x24c/3865333998465762597.png",
                "initid": 66518,
                "name": null,
                "revision": 0
            },
            "uri": "/tmp32/api/v1/documents/66518.json"
        }
    }
}

L'url indiquée dans la caractéristique "icon" est l'image redimensionnée. L'url de l'image original est :

api/v1/images/recorded/original/3865333998465762597.png

16.3.2 Structure de retour

Le retour est le contenu du fichier. En cas d'échec, une structure JSON est retournée avec l'erreur si aucune extension n'est indiquée dans l'url. Si une extension (différente de json) est indiquée alors l'erreur affiché sera un texte brut.

16.3.3 Paramètres

Le paramètre inline permet de modifier l'entête HTTP pour demander au navigateur un téléchargement de fichier ou un affichage dans le navigateur dans le cas où celui-ci permet son affichage.

Par défaut, le téléchargement est demandé. L'entête contient

Content-Disposition: attachment

Si inline vaut "true", "1" ou "yes", la disposition vaut :

Content-Disposition: inline

16.3.4 Exemple :

Récupération des informations sur la propriété "icon" du document 66518.

GET http://localhost/tmp/api/v1/documents/66518?fields=document.properties

Réponse :

{
    "success": true,
    "messages": [],
    "data": {
        "document": {
            "properties": {
                "id": 66518,
                "title": "Panda",
                "icon": "api/v1/images/recorded/sizes/24x24c/3865333998465762597.png",
                "initid": 66518,
                "name": null,
                "revision": 0
            },
            "uri": "/tmp32/api/v1/documents/66518.json"
        }
    }
}

La réponse de la consultation d'un document contient l'url de téléchargement (dans la propriété url) de l'attribut.

Téléchargement de l'icône "mime-pdf.png" associée au type mime "application/pdf":

GET http://localhost/tmp/api/v1/images/assets/original/mime-pdf.png

Téléchargement de l'original d'une icône enregistrée dans le coffre

GET http://localhost/tmp/api/v1/images/recorded/original/3865333998465762597.jpg