API

Presentation

Afin de vous aider à créer votre propre application de consultation du matériel mis à disposition sur notre site, nous mettons à disposition notre API REST.
Celle-ci est accessible à tous, et à tout moment.

Conditions d'utilisation

En utilisant cette API, vous vous engagez à respecter notre clause relative à l'utilisation des données personnelles, telle que définie dans nos mentions légales.
Ainsi, vous ne devrez pas traiter les données à caractère personnel (téléphones, courriels...) renseignées par les utilisateurs.

Avertissement

Cette API étant libre d'accès, nous vous prions d'en avoir une utilisation raisonnable, et d'éviter les requêtes trop fréquentes, qui risqueraient de surcharger notre site.
Pour toute question technique sur l'utilisation de l'API, ou pour tout problème rencontré, n'hésitez pas à ouvrir une "issue" sur notre GitHub.

Utilisation

nb : les recherches sont insensibles à la casse

/search

Retourne, parmi les groupes de microscopes présents sur le site, ceux comportant au moins une occurrence d'un des filtres fournis, parmis leur matériel (société, marque, modèle, électronique), leur description, leurs mots-clés, ou le nom de famille d'un·e de leurs référent·e·s.

La recherche s'effectue donc avec un ou logique entre les filtres

Paramètres

Nom Type Requis
filters array(string) | string non

Exemples

/list_compagnies

Retourne toutes les sociétés.

Paramètres

Aucun

Exemple

/api/v1/list_compagnies.php

/list_brands

Retourne toutes les marques, ou les marques d'une société donnée.

Paramètres

Nom Type Requis
compagny string non

Exemples

/list_models

Retourne tous les modèles de microscope, ou les modèles de microscope d'une marque donnée.

Paramètres

Nom Type Requis
brand string non

Exemples

/list_controllers

Retourne toutes les électroniques, ou les électroniques d'une marque donnée.

Paramètres

Nom Type Requis
brand string non

Exemples