API
Rechercher les disponibilités
Récupérer les objets disponibles sur une date ou une période, en mode strict (moteur de recherche) ou normal (détail jour par jour).
GEThttps://api.millcheck.fr/public/availability
Retourne les objets disponibles aux dates demandées. Deux modes de recherche sont proposés :
Mode strict
À privilégier pour les moteurs de recherche. Retourne les objets disponibles sur toute la période de séjour. Inclut les prix « à partir de » des places de marché (OpenSystem).
Mode normal
Retourne le détail jour par jour : pour chaque date, l’état de chaque objet. Aucun prix n’est retourné.
Paramètres
api_key
string required
Clé d’API de votre organisation.
date_start
string required
Date de début, au format
YYYY-MM-DD. Exemple : 2026-07-14.date_end
string required
Date de fin, au format
YYYY-MM-DD. Exemple : 2026-07-16.mode
string
normal ou strict. Par défaut : normal.ids_includes
array
Restreint la recherche à ces identifiants SIT. Doit contenir au moins une valeur.
ids_excludes
array
Exclut ces identifiants SIT de la recherche.
Interprétation des dates selon le mode
- En mode
strict, la période est lue comme un séjour :date_startest le jour d’arrivée etdate_endle jour de départ. Les nuits vérifiées vont dedate_startà la veille dedate_end. Pour une nuit du 14 au 15 juillet :date_start=2026-07-14&date_end=2026-07-15. - En mode
normal,date_startetdate_endsont inclus : chaque jour de la période est retourné.
Les tableaux se passent avec la notation à crochets :
?ids_includes[]=149052&ids_includes[]=205976
Exemples
curl -G "https://api.millcheck.fr/public/availability" \
--data-urlencode "api_key=VOTRE_CLE_API" \
--data-urlencode "date_start=2026-07-14" \
--data-urlencode "date_end=2026-07-16" \
--data-urlencode "mode=strict"
curl -G "https://api.millcheck.fr/public/availability" \
--data-urlencode "api_key=VOTRE_CLE_API" \
--data-urlencode "date_start=2026-07-14" \
--data-urlencode "date_end=2026-07-16" \
--data-urlencode "ids_includes[]=149052" \
--data-urlencode "ids_includes[]=205976"
$url = 'https://api.millcheck.fr/public/availability?' . http_build_query([
'api_key' => 'VOTRE_CLE_API',
'date_start' => '2026-07-14',
'date_end' => '2026-07-16',
'mode' => 'strict',
'ids_excludes' => [313941],
]);
$response = json_decode(file_get_contents($url), true);
$idsDisponibles = array_keys($response['datas']['objects']);
Réponse
success
boolean
true si la requête a abouti.datas.objects
object
Objets disponibles, indexés par identifiant SIT.
name
string
Nom de l’objet.
type
string
Type d’objet SIT (
HOTELLERIE, MEUBLE_GITE, HEBERGEMENT_LOCATIF…).id_sit
string
Identifiant SIT.
sit
string
SIT d’origine de l’objet.
datas
object
Informations complémentaires issues du SIT :
image, commune_code_postal, commune_nom, users (e-mails), tels, OpenSystem (identifiant place de marché), nuitee, classements.datas.days_objects
object
Mode normal uniquement. Pour chaque date, l’état de chaque objet :
0 non disponible, 1 disponible, 4 quelques places disponibles.datas.ids_os_availables
object
Mode strict uniquement. Pour chaque objet connecté à une place de marché, l’identifiant OpenSystem (
ui) et le prix « à partir de » (prix).{
"success": true,
"datas": {
"objects": {
"149052": {
"name": "Hôtel-Restaurant Bellier",
"type": "HOTELLERIE",
"id_sit": "149052",
"sit": "apidae",
"datas": {
"image": "https://exemple.com/images/hotel-bellier.jpg",
"commune_code_postal": "26420",
"commune_nom": "La Chapelle-en-Vercors",
"users": [
{ "source": "Informations", "email": "exemple@exemple.com" }
],
"tels": ["01 23 45 67 89"],
"OpenSystem": "CF-AVAI-93288",
"nuitee": false,
"classements": { "2749": "2 étoiles" }
}
}
},
"ids_os_availables": {
"149052": { "ui": "CF-AVAI-93288", "prix": 540 }
}
}
}
{
"success": true,
"datas": {
"objects": {
"205976": { "name": "Gîte des Cévennes", "type": "MEUBLE_GITE", "id_sit": "205976", "sit": "apidae", "datas": { "...": "..." } }
},
"days_objects": {
"2026-07-14": { "205976": 1, "5690981": 1, "5388150": 0, "313941": 4 },
"2026-07-15": { "205976": 1, "5690981": 0, "5388150": 0, "313941": 4 },
"2026-07-16": { "205976": 0, "5690981": 0, "5388150": 1, "313941": 1 }
}
}
}
En mode normal,
datas.objects contient les objets disponibles au moins un jour de la période. Utilisez days_objects pour connaître le détail jour par jour.Erreurs
| Code | Message | Cause |
|---|---|---|
400 | api_key param is required | Paramètre api_key absent |
400 | date_start param is required | Paramètre date_start absent |
400 | date_end param is required | Paramètre date_end absent |
400 | Invalid mode | mode différent de normal ou strict |
400 | ids_includes must be an array | ids_includes passé sans crochets |
400 | ids_includes cannot be null | ids_includes vide |
400 | ids_excludes must be an array | ids_excludes passé sans crochets |
401 | api_key is not valid | Clé d’API inconnue |