Ce document présente les fonctionnalités exposées par l'API NetExplorer.
Celle-ci est basée sur l'architecture REST, reposant sur le protocole HTTP, permettant ainsi aux développeurs de tirer pleinement parti de leur plateforme de stockage NetExplorer, et mettre au point une solution logicielle répondant aux besoins de leur entreprise.

L'API est accessible en ajoutant /api à l'adresse de votre plateforme.
L'accès aux différents modules se fera donc via des URLs sous la forme https://exemple.fr/api/module.

Enfin, si vous souhaitez rester informé des modifications de la documentation API, vous pouvez vous inscrire à notre liste de diffusion dédiée en cliquant ici : Rester informé

En-têtes HTTP utilisés pour les requêtes:

Info Consultez la section Authentification pour savoir comment obtenir un token.

En-têtes HTTP utilisés pour les réponses:

Info Les codes HTTP standards sont à prendre en compte lorsque le serveur répond aux requêtes.

Quelques en-têtes communs:

Note Les structures présentées ci-dessous sont affichées sous la forme d'un objet JSON. Il s'agit du seul format proposé par l'API.
Pour l'exploiter correctement, certains points sont à savoir:

• Les dates sont toujours soit au format ISO 8601, soit sous forme de timestamp unix.
• Les identifiants uniques des utilisateurs/groupes sont des chaines de caractères (string) et non pas des entiers numériques (int).
• Les tailles des fichiers/dossiers sont toujours indiquées en octets, et doivent être considérées comme des long.

Structure d'un dossier

{
    "files": [
        // Objets Fichier
        {
            "id": 1,
            "name": [
                ...
            ]
        },
        ...
    ],
    "folders": [
        // Objets Dossier
        {
            "id": 1,
            "name": [
                ...
            ]
        },
        ...
    ]
}

Exemple d'objet JSON

{
    "id": 1,
    "name": "Documents",
    "parent_id": 0,
    "can_read": true,
    "can_download": true,
    "can_write": false,
    "can_edit": false,
    "can_delete": false,
    "can_share": true,
    "content": {
        "files": [
            {
                "id": 1,
                "name": [
                    ...
                ]
            },
            ...
        ],
        "folders": [
            {
                "id": 2,
                "name": [
                    ...
                ]
            },
            ...
        ],
        
        // Les paramètres suivants ne sont pas disponibles en mode light
    },
    "creation": "2015-08-01T02:00:00+02:00",
    "modification": "2015-08-01T02:00:00+02:00",
    "owner": "Jean DUPOND",
    "owner_id": [
        
        // Les paramètres suivants ne sont disponibles qu'en mode complet
    ],
    "can_dlink": true,
    "can_ulink": true,
    "can_admin_rights": false,
    "can_admin_alerts": false,
    "self_alert": true,
    "nb_participants": 0,
    "nb_annotations": 4,
    "nb_unread_annotations": 1,
    "size": 1128963,
    "nb_d_folders": 1,
    "nb_d_files": 5,
    "nb_folders": 1,
    "nb_files": 14,
    "quota": -1,
    "purge_frequency": 0,
    "path": "/"
}

Structure d'un fichier

{
    "author": "Luc MARCHAND",  // Auteur du document
    "creator": "LibreOffice",  // Logiciel de traitement de texte utilisé
    "date": "Sun Sep  1 00:00:00 2013",  // Date de dernière édition du document
    "keywords": "mots clés document",  // Mots clés
    "pages": 10,  // Nombre de pages
    "producer": "GhostScript",  // Logiciel ayant produit le fichier
    "subject": "Détail des ventes pour l'année 2013",  // Sujet détaillé du document
    "title": "Rapport ventes 2013"  // Titre du document
}

Exemple d'objet JSON

{
    "id": 458,
    "name": "MonImage.jpg",
    "parent_id": 1,
    "creation": "2015-08-01T02:00:00+02:00",
    "modification": "2015-08-01T02:00:00+02:00",
    "can_download": true,
    "can_write": false,
    "can_edit": false,
    "can_delete": false,
    "can_share": true,
    "owner": "Jean DUPOND",
    "owner_id": "4",
    "hash": "d41d8cd98f00b204e9800998ecf8427e",
    "lock": [
        
        // Les paramètres suivants ne sont disponibles qu'en mode complet
    ],
    "nb_versions": 7,
    "nb_annotations": 4,
    "nb_unread_annotations": 1,
    "meta": {
        "author": "Luc MARCHAND",
        "creator": "LibreOffice",
        "date": "Sun Sep  1 00:00:00 2013",
        "keywords": "mots clés document",
        "pages": 10,
        "producer": "GhostScript",
        "subject": "Détail des ventes pour l'année 2013",
        "title": "Rapport ventes 2013"
    },
    "thumbs_token": "2uYPfBWitiof...",
    "file_type": "image",
    "path": "/1/"
}

Structure d'un élément de la corbeille

Exemple d'objet JSON

{
    "id": 11567,
    "name": "MonFichier.txt",
    "is_file": true,
    "deletion": "2015-07-18T20:59:00+0200",
    "modification": "2015-06-24T15:45:28+0200",
    "owner": "Bob Jensen",
    "owner_id": "22",
    "size": 15632
}

Structure d'une annotation

Exemple d'objet JSON

{
    "id": 24,
    "target_id": 11567,
    "target_type": "file",
    "owner": "Jack JAUFFRE",
    "owner_id": "4558",
    "date": "2015-07-28T12:58:26+02:00",
    "text": "Voici le contenu de mon annotation",
    "conversation": null
}

Structure d'un verrou

Exemple d'objet JSON

{
    "file": "00000000-0000-0000-0000-000000000000",
    "owner": "Edouard DESPEREAUX",
    "owner_id": "125696",
    "locked": true,
    "writeable": false,
    "readable": true
}

Structure d'un droit

Exemple d'objet JSON

{
    "id": 56629,
    "folder_id": 36948,
    "target_id": "4673",
    "target": [
        
    ],
    "browse": true,
    "read": true,
    "download": true,
    "write": false,
    "edit": false,
    "delete": false,
    "share": false
}

Structure d'une alerte email

Exemple d'objet JSON

{
    "id": 104,
    "folder_id": 1,
    "target_id": 3,
    "target": "José SANCHEZ",
    "target_isgroup": false,
    "active": true,
    "email": -1,
    "expiration_date": null,
    "owner": "Hervé FIGIS",
    "owner_id": 14
}

Structure d'un utilisateur

Exemple d'objet JSON

{
    "id": "15",
    "firstname": "Noël",
    "lastname": "FLANTIER",
    "login": "n.flantier",
    "email": [
        
    ],
    "roots": [
        14,
        18,
        24,
        
    ],
    "organization": "OSS",
    "phone": "",
    "active": true,
    "language": "fr",
    "quota": null,
    "expire": null,
    "creation_date": null,
    "last_login": "2020-06-16T13:14:08+00:00",
    "plugin_outlook": 128,
    "ldap": false,
    "can_edit_options": true,
    "can_admin": false,
    "can_admin_users": false,
    "groups": [
        {
            "id": 4,
            "login": "Agents opérationnels",
            "ldap": false
        },
        {
            "id": 14,
            "login": "Top Secret",
            "ldap": false
        }
    ],
    "has_mfa_yubikey": false,
    "has_mfa_otp": false,
    "has_mfa_sms": true,
    "can_mfa_yubikey": false,
    "can_mfa_otp": false,
    "can_mfa_sms": true,
    "mfa_required": false,
    "role": 3
}

Structure d'une invitation

Exemple d'objet JSON

{
    "id": 9,
    "key": "3Rjy060qP5rrJx4qRz5KdcTS",
    "source": 5,
    "source_name": "Bob Herry",
    "target": "bob.herry@oss.gouv.fr",
    "expiration": null,
    "folder": 64,
    "rights": 3
}

Structure d'un groupe

Exemple d'objet JSON

{
    "id": "78",
    "login": "Marketing",
    "ldap": false,
    "members": [
        {
            "id": "14",
            "firstname": "Jacques",
            "lastname": "JOBERT",
            "login": [
                ...
            ]
        },
        {
            "id": "145",
            "firstname": "Elodie",
            "lastname": "CARNERA",
            "login": [
                ...
            ]
        },
        ...
    ]
}

Structure des options de connexions

Exemple d'objet JSON

{
    "target_id": "1",
    "target": "Administrateurs NetExplorer",
    "target_isgroup": true,
    "ips": null,
    "days": 62,  // Lundi => Vendredi
    "hour_start": "07:00:00",  // 7h GMT
    "hour_end": "16:00:00",  // 16h GMT
    "can_netsync": true,
    "inherited": false
}

Structure d'un délégué de groupe OBSOLÈTE

Exemple d'objet JSON

{
    "id": 60,
    "user": "Jennifer BRANT",
    "user_id": 186,
    "group_id": 17,
    "users": true,
    "security": false,
    "alerts": true
}

Structure d'un email

Structure d'un partage par lien

Exemple d'objet JSON

{
    "id": 4559,
    "key": "258fqwu987y57D",
    "roots": [
        {
            "id": 1,
            "entity_type": 0,
            "share_id": 4559,
            "name": "Fichier de test.pdf",
            "can_download": true,
            "can_preview": true,
            "can_edit": false,
            "size": 311111,
            "is_file": false,
            "parent_id": 23,
            "file_type": "document",
            "guid": "00000-0000-00000-00000",
            "extension": "pdf"
        },
        {
            "id": 2,
            "entity_type": 1,
            "share_id": 4559,
            "name": "Dossier partagé",
            "can_download": true,
            "can_preview": true,
            "can_edit": false,
            "size": 311111,
            "is_file": false,
            "parent_id": 23
        }
    ],
    "flags": 4,  // Aperçu et téléchargement
    "expiration_date": null,
    "creation_date": "14/02/2024",
    "owner": "Amir BEN OUALI",
    "owner_id": 55
}

Structure d'un contenu de partage

Exemple d'objet JSON

[
    {
        "id": 1,
        "entity_type": 0,
        "share_id": 4559,
        "name": "Fichier de test.pdf",
        "can_download": true,
        "can_preview": true,
        "can_edit": false,
        "size": 311111,
        "parent_id": 23,
        "file_type": "document",
        "guid": "00000-0000-00000-00000",
        "extension": "pdf"
    },
    {
        "id": 2,
        "entity_type": 1,
        "share_id": 4559,
        "name": "Dossier partagé",
        "can_download": true,
        "can_preview": true,
        "can_edit": false,
        "size": 311111,
        "parent_id": 23
    }
]

Structure d'un partage par lien (ancien) OBSOLÈTE

"downloads": [
    {
        "id": 124589,
        "date": "2016-01-25T19:58:56Z",
        "user": null,
        "user_id": null,
        "geo": {
            "city": "Lyon",
            "country": "France",
            "loc": "Lyon, France"
        },
        "env": {
            "browser": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36",
            "os": "Mac OS X",
            "os_type": 2
        }
    }
],
"users": 2

Exemple d'objet JSON

{
    "id": 4559,
    "key": "258fqwu987y57D",
    "file_id": 1,
    "file": "Guide de prise en main.pdf",
    "file_size": 455663,
    "is_valid": true,
    "expiration_date": null,
    "password_protected": "5e3db300c59409695d5e3943e5f2532486e7b8dd",
    "remaining_downloads": null,
    "thumb_token": "JB%252F3j3r7Q%25[...]z2MXMloxO3kcAw%253D%253D",
    "file_type": "document",
    "owner": "Amir BEN OUALI",
    "owner_id": 55,
    "nb_downloads": 45,
    "max_downloads": null,
    "notify": true,
    "autoupdate": false,
    "stats": {
        "downloads": [
            {
                "id": 124589,
                "date": "2016-01-25T19:58:56Z",
                "user": null,
                "user_id": null,
                "geo": {
                    "city": "Lyon",
                    "country": "France",
                    "loc": "Lyon, France"
                },
                "env": {
                    "browser": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36",
                    "os": "Mac OS X",
                    "os_type": 2
                }
            }
        ],
        "users": 2
    }
}

Structure d'un partage par email

Exemple d'objet JSON

{
    "id": 12,
    "object": "Objet de l'email",
    "content": "Bonjour, ci joint un partage par email.",
    "owner_id": 1,
    "share_id": 13,
    "creation_date": "2021-04-21T10:04:20+00:00",
    "recipients": [
        {
            "email": "email@netexplorer.fr"
        }
    ]
}

Structure d'un partage par email (ancien) OBSOLÈTE

Exemple d'objet JSON

{
    "id": "12",
    "object": "Objet de l'email",
    "content": "Bonjour, ci joint un partage par email.",
    "owner": 1,
    "stats": {
        "nb_download": 1,
        "nb_preview": 1
    },
    "sendind_date": "2021-04-21T10:04:20+00:00",
    "recipients": [
        {
            "email": "email@netexplorer.fr",
            "name": "Bob Bob",
            "id": "123",
            "dlink": [  // Objet partage par lien
                {
                    "id": 14,
                    ...
                }
            ]
        }
    ]
}

Structure d'un lien de dépôt

Exemple d'objet JSON

{
    "id": 4456,
    "key": "258fqwu987y57D",
    "folder": "Dépôt externe",
    "folder_id": 4,
    "is_valid": true,
    "expiration_date": "2018-01-01T12:00:00+00:00",
    "owner": "Erica JONES",
    "owner_id": "3"
}

Structure d'un template de fichier

Structure d'un flux de travail

Exemple d'objet JSON

{
    "id": 12,
    "object_type": null,
    "object_id": null,
    "properties": [
        {
            "signatures": [
                {
                    "email": "email@netexplorer.fr"
                },
                ...
            ]
        },
        {
            "signature_fields": [
                {
                    "x": 123,
                    "y": 321,
                    "page": 1,
                    "signerIndex": 0,
                    "document": 0
                },
                ...
            ]
        },
        {
            "objects": [
                {
                    "type": "file",
                    "id": 1
                },
                ...
            ]
        },
        ...
    ],
    "owner_id": 2,
    "creation": "2024-01-01 00:00:00",
    "edit": "2024-01-01 00:00:00",
    "is_closed": false,
    "state": {
        "id": 3,
        "name": "FLOW_STATES_NAME_WAITINGSIGNATURE"
    },
    "flux": {
        "id": 2,
        "name": "FLOW_NAME_DOCSIGNATURE",
        "description": "FLOW_DESC_DOCSIGNATURE"
    },
    "data_objects": [
        {
            "type": "file",
            "id": 1
        },
        ...
    ],
    "transitions_available": {
        "DocumentHandwrittenSignedTransition": [
            {
                "name": "FLOW_STATES_NAME_SIGNED",
                "id": 4
            },
            ...
        ]
    }
}

Structure d'une entrée des journaux d'évènements

Exemple d'objet JSON

{
    "id": 33837,
    "user_id": 2,
    "user": "Bob Jensen",
    "date": "2013-09-17T11:31:28+00:00",
    "message": "",
    "ip": "8.5.2.1",
    "user_agent": "Mozilla/5.0 (Windows NT 6.1; WOW64; rv:31.0) Gecko/20100101 Firefox/31.0",
    "type": "ADMLLOG_INSERT",
    "statut": "ADMLLOG_OK",
    "object_id": 11007,
    "object_type": "Dossier",
    "object": "Documents/Comptabilité/2015"
}

Informations sur l'environnement utilisateur

Exemple d'objet JSON

{
    "browser": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)",
    "os": "Windows 10",
    "os_type": 1
}

Informations de géolocalisations

Exemple d'objet JSON

{
    "city": "Colomiers",
    "country": "France",
    "loc": "Colomiers, France"
}