API GET FReSH
L’API GET FReSH permet de :
- Rechercher des études
- Filtrer les résultats
- Consulter les détails
- Télécharger les données
Endpoint
- Méthode : GET
- URL du serveur : https://nada.portail-fresh.fr/index.php/api/catalog
- URL d'export : https://nada.portail-fresh.fr/index.php/metadata/export/
Paramètres
Filtres de contenu
| Paramètre | Type | Description |
|---|---|---|
| sk | string | Mots-clés pour la recherche dans les métadonnées de l'étude. |
| country | string | Nom du pays ou code ISO3. Séparez par une barre verticale (|) pour plusieurs pays (ex: afg|ind). |
| collection | string | Filtrer par collections. Séparez par des virgules (ex: coll1, coll2). |
| dtype | string | Type d'accès : open, direct, public, licensed, enclave, remote, other. |
Filtres temporels
| Paramètre | Type | Description |
|---|---|---|
| from | int | Année de début de la collecte des données. |
| to | int | Année de fin de la collecte des données. |
| created | string | Date de création (YYYY-MM-DD). Format YYYY/MM/DD pour "à partir de", ou date1-date2 pour une plage. |
Mise en page et export
| Paramètre | Type | Description |
|---|---|---|
| ps | int | Taille de la page (Nombre de résultats). Par défaut : 15. |
| page | int | Numéro de la page à retourner. |
| sort_by | enum | Trier par: rank, title, nation, year. |
| sort_order | enum | Ordre : asc (croissant) ou desc (décroissant). |
| format | string | Format de réponse : json ou xml. |
| inc_iso | boolean | True pour inclure les codes ISO3 dans les résultats. |