Utiliser l’API

eCorpus fournit une API complète qui couvre les besoins de DPO Voyager en y ajoutant des interfaces de gestion des utilisateurs, contrôle des droits d’accès, organisation des scènes en collections, etc…

Authentification

Pour s’authentifier en ligne de commande, utiliser un header Authorization avec la valeur Basic <base64(username:password)>.

L’encodage du header est géré automatiquement par la plupart des utilitaires. Exemple avec curl :

curl -XGET -u "<username>:<password>" https://ecorpus.holusion.com/[...]

Organisation des scenes

Organisation des fichiers :

├── foo/
│   ├── scene.svx.json
│   ├── scene-image-thumb.jpg
│   ├── models/
│   │   └── foo.glb
│   └── articles/
│       └── foo-FR.html
└── bar/
    ├── scene.svx.json
    ├── scene-image-thumb.jpg
    ├── models/
    │   └── bar.glb
    └── articles/
        └── bar-FR.html

Ainsi pour récupérer un modèle :

curl -XGET -u "<username>:<password>" https://ecorpus.holusion.com//scenes/foo/models/foo.glb

Les verbes GET PUT MOVE COPY DELETE MKCOL et PROPFIND sont supportés, avec un comportement se conformant généralement à la spécification. Attention tout de même : Il s’agit d’une implémentation partielle de la spécification.

API REST

L’API REST est documentée via un schéma OpenAPI v3.1.0, téléchargeable ici : openapi.yml. L’API est présentée sous forme lisible en anglais uniquement sur ce site à cette page : https://ecorpus.eu/en/doc/references/api.