API
Lister les objets
Récupérer la liste des identifiants SIT des objets ayant des disponibilités à jour.
GEThttps://api.millcheck.fr/public/objects
Retourne la liste des identifiants SIT des objets de votre organisation dont les disponibilités sont à jour, c’est-à-dire au statut active ou partially (voir Concepts clés).
Utilisez cet endpoint pour savoir sur quelles fiches afficher le widget planning : un objet absent de cette liste ne doit pas présenter de calendrier.
À appeler régulièrement, une fois par jour ou par nuit, pour tenir à jour la liste des objets actifs sur votre site.
Paramètres
api_key
string required
Clé d’API de votre organisation.
Exemple
curl "https://api.millcheck.fr/public/objects?api_key=VOTRE_CLE_API"
$url = 'https://api.millcheck.fr/public/objects?' . http_build_query([
'api_key' => 'VOTRE_CLE_API',
]);
$response = json_decode(file_get_contents($url), true);
if ($response['success']) {
$idsAvecDispos = $response['datas'];
}
const params = new URLSearchParams({ api_key: 'VOTRE_CLE_API' })
const response = await fetch(`https://api.millcheck.fr/public/objects?${params}`)
const { success, datas } = await response.json()
Réponse
success
boolean
true si la requête a abouti.datas
number[]
Identifiants SIT des objets avec des disponibilités valides.
200 OK
{
"success": true,
"datas": [5978683, 5978990, 5979544]
}
Erreurs
| Code | Message | Cause |
|---|---|---|
400 | api_key param is required | Paramètre api_key absent |
401 | api_key is not valid | Clé d’API inconnue |