Vocabulaire
Les entités
| Nom français | Définition | Terminologie API |
|---|---|---|
| Utilisateur | Une personne authentifiée sur la plateforme | user |
| Communauté | Groupe d'utilisateurs avec certains droits sur la communauté en elle même et sur son éventuel entrepôt associé | community |
| Entrepôt | Ensemble de données, fichiers statiques, configurations | datastore |
| Livraison | Une donnée temporaire, point d'entrée des données sur la plateforme, exploitable par des traitements | upload |
| Vérification | Un script de vérification disponible sur la plateforme, exécutable sur une livraison | check |
| Exécution de vérification | Une exécution d'une vérification sur une livraison en particulier | check execution |
| Donnée stockée | Une donnée stockée de manière pérenne sur l'entrepôt | stored_data |
| Traitement | Un script de traitement des données, avec des paramètres et des contraintes sur le type de données en entrée et un type de donnée en sortie | processing |
| Exécution de traitement | Une exécution d'un traitement, avec des données en entrée et une en sortie, des valeurs de paramètre | processing execution |
| Annexe | Document indépendant, dont on choisit si il est diffusé publiquement et selon quel chemin | annexe |
| Configuration | Ensemble d'informations décrivant la manière de diffuser des données sur un géoservice | configuration |
| Offre | Entité représentant la présence d'une configuration sur un point d'accès | offering |
| Point d'accès | Entité représentant un ensemble de serveurs de diffusion géographique, accessible via une URL | endpoint |
| Permission | Possibilité d'accès à une offre donnée à un utilisateur ou une communauté | permission |
| Accès | Autorisation d'une clé à consommer une offre | access |
| TMS | Un Tile Matrix Set, statique pour la plateforme, utilisé par les données stockées de type pyramide ROK4 | tms |
Liens entre entités
Les raccourcis
Une donnée est une livraison ou une donnée stockée. Les termes en gras correspondent à des entités manipulées via l'API (détaillées dans l'onglet "Concepts"). Dans les exemples d'appels aux API, les identifiants seront toujours remplacé par {id} et se rapportent à l'entité qui le précède. Le mot "plateforme" désigne l'ensemble des communautés et entrepôts.
Généralités sur l'API
La pagination
Les API permettant de récupérer des entités potentiellement nombreuses sont paginées, c'est à dire qu'elles ne retournent que des résultats partiels, définis par l'utilisateur lors de l'appel. Les API concernées sont étiquetées comme telles dans les spécifications OpenAPI.
L'appel à l'API se fait avec les paramètres page (numéro de page, en commençant à 1, 1 par défaut) et limit (nombre d'entités dans une page, limité à 50, 10 par défaut). Le corps de la réponse est alors un tableau contenant les entités. Les informations de pagination sont dans l'en-tête de la réponse. Par exemple, à l'appel GET /entities?page=12&limit=50 :
Content-Range: 551-600/971
Link : </entities?page=1&limit=50>; rel="first",
</entities?page=11&limit=50>; rel="previous",
</entities?page=13&limit=50>; rel="next",
</entities?page=20&limit=50>; rel="last"
Les erreurs
Les statuts HTTP retournés permettent de décrire globalement le type d'erreur rencontrée. Une réponse JSON est retournée, de la forme :
{
"error": "titre de l'erreur",
"error_description": "description permettant de définir la raison de l'erreur"
}