Documentation de l'API

Données quotidiennes

Lire le statut du jour par date

en utilisant la Géo-ID en utilisant la City-ID Suisse / Liechtenstein : en utilisant de code postal

Suisse / Liechtenstein : en utilisant de numéro de la municipalité FSO

API: CheckDate/CH/BFS

Obtient les jours fériés et les vacances scolaires pour une date donnée, en se basant sur un numéro de commune suisse (BFS).

Fonction

Cette API détermine si un jour férié officiel ou des vacances scolaires ont lieu à une date donnée dans un lieu donné. Les paramètres requis sont `api_key` et `bfs`. Le paramètre `date` est facultatif - s'il n'est pas indiqué, la date du jour est automatiquement utilisée. En outre, la sortie peut être configurée à l'aide d'autres paramètres. Les paramètres sont transmis comme paramètres de requête dans l'URL. Alternativement, l'autorisation peut être donnée dans l'en-tête.

Guide interactif et OpenAPI

OpenAPI 3.0 (Swagger) – Documentation interactive sur l'API

Ouvre la documentation interactive de l'API avec Swagger, dans laquelle vous pouvez tester et explorer les points finaux de l'API.

Télécharger la spécification OpenAPI JSON

Chapitres de l'API

URL pour les requêtes
Paramètres des requêtes
Exemples (URL / PHP / Python / JavaScript)
Valeurs de retour de l'API
Exemples (JSON / XML / CSV)
Messages d'erreur

URL pour les requêtes

Pour récupérer les données, utilisez l'URL suivante. Veuillez faire attention aux majuscules et aux minuscules.

POST / GET

https://feiertagskalender.ch/api/CheckDate/CH/BFS/index.php

Paramètres des requêtes

Les variables suivantes vous permettent de compléter la requête et de contrôler les résultats de l'API.

Paramètre	Explication	Exemples
api_key requis	Votre clé API	api_key=abc-123-def-456
BFS requis	Numéro de la commune suisse selon l'OFS (Office fédéral de la statistique)	BFS=261
date	La date à vérifier sans spécification : aujourd'hui (= standard)	date=2025-06-01
class oubièn klasse	Portée des données Variantes : 0 = vacances scolaires uniquement 3 = 0 + jours fériés reconnus par la loi 4 = 0 + 3 + jours fériés (religieux, culturels) et non fériés (= standard) 5 = 0 + 3 + 4 + jours d'événements (par exemple, le Saint-Valentin, la fête des mères, les dimanches de l'Avent))	klasse=5
charset	Le codage souhaité de la réponse Variantes : UTF-8 (= standard) ISO-8859-1	charset=iso-8859-1
format	Le format de sortie souhaité Variantes : JSON (= standard) XML CSV	format=xml
date_format	Le format de date souhaité pour la réponse. Par défaut:`Y-m-d` (ex., 2025-12-31) Le format correspond au formatage de la date de l'instruction PHP date() Variantes : Y-m-d = YYYY-MM-DD (ISO-8601) (= standard) d.m.Y = DD.MM.YYYY Ymd = YYYYMMDD dmY = DDMMYYYY d.m.y = DD.MM.YY j.n.y = D.M.YY	date_format=d.m.Y
hl	Langue de sortie souhaitée Variantes : de = Allemand (= standard) fr = Français it = Italien en = Anglais	hl=en

Exemples (URL / PHP / Python / JavaScript)

Afficher les exemples

Paramètres dans l'URL

Ainsi, des paramètres peuvent être inclus dans l'URL (par exemple via le navigateur, ou dans Excel) :
Remarque : Le premier paramètre est précédé de ?, tous les autres paramètres sont précédés de &.

Important : ce code ne doit pas être utilisé directement dans une page web ! Pour des raisons de sécurité, les clés API doivent être traitées uniquement dans le backend.

https://feiertagskalender.ch/api/CheckDate/CH/BFS/index.php?api_key=YOUR_API_KEY&bfs=261&date=2025-12-25

Exemple PHP avec cURL (GET)

$api_url = "https://feiertagskalender.ch/api/CheckDate/CH/BFS/index.php?bfs=261&date=2025-12-25";
$api_key = "YOUR_API_KEY";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
   "Authorization: Bearer $api_key",
   "Content-Type: application/json"
]);
$response = curl_exec($ch);
curl_close($ch);

echo $response;

Exemple PHP avec cURL (POST)

$api_url = "https://feiertagskalender.ch/api/CheckDate/CH/BFS/index.php";
$api_key = "YOUR_API_KEY";

// POST-Daten
$post_data = json_encode([
    "bfs": "261", "date": "2025-12-25"	
]);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer $api_key",
    "Content-Type: application/json"
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

Exemple Python avec requests (GET)

import requests

api_key = "YOUR_API_KEY"
api_url = "https://feiertagskalender.ch/api/CheckDate/CH/BFS/index.php?bfs=261&date=2025-12-25"
headers = {
    "Authorization": f"Bearer {api_key}",
    "Content-Type": "application/json"
}

response = requests.get(api_url, headers=headers)

if response.status_code == 200:
    print(response.json())  # JSON
else:
    print(f"Error: {response.status_code}", response.text)

Exemple Python avec requests (POST)

import requests

api_key = "YOUR_API_KEY"
api_url = "https://feiertagskalender.ch/api/CheckDate/CH/BFS/index.php"
headers = {
    "Authorization": f"Bearer {api_key}",
    "Content-Type": "application/json"
}

payload = {
    "bfs": "261", "date": "2025-12-25"	
}

response = requests.post(api_url, headers=headers, json=payload)

if response.status_code == 200:
    print(response.json())  # JSON
else:
    print(f"Error: {response.status_code}", response.text)

Exemple JavaScript avec Fetch API (GET)

L'API Fetch est une méthode moderne pour effectuer des requêtes HTTP en JavaScript. Elle est prise en charge par les navigateurs actuels.

Important : ce code ne doit pas être utilisé directement dans une page web ! Pour des raisons de sécurité, les clés API doivent être traitées uniquement dans le backend.

const apiUrl = "https://feiertagskalender.ch/api/CheckDate/CH/BFS/index.php?bfs=261&date=2025-12-25";
const apiKey = "YOUR_API_KEY";  								
const headers = new Headers({
    "Authorization": "Bearer " + apiKey,
    "Content-Type": "application/json"
});

fetch(apiUrl, { method: "GET", headers })
    .then(response => {
        if (!response.ok) {
            throw new Error(`Error: ${response.status} ${response.statusText}`);
        }
        return response.json();
    })
    .then(data => console.log(data))
    .catch(error => console.error("Error:", error));

Exemple JavaScript avec Fetch API (POST)

L'API Fetch est une méthode moderne pour effectuer des requêtes HTTP en JavaScript. Elle est prise en charge par les navigateurs actuels.

const apiUrl = "https://feiertagskalender.ch/api/CheckDate/CH/BFS/index.php";
const apiKey = "YOUR_API_KEY";  
const requestData = {
    "bfs": "261", "date": "2025-12-25"	
};

fetch(apiUrl, {
    method: "POST",
    headers: {
        "Authorization": "Bearer " + apiKey,
        "Content-Type": "application/json"
    },
    body: JSON.stringify(requestData)
})
.then(response => {
    if (!response.ok) {
        throw new Error(`Error: ${response.status} ${response.statusText}`);
    }
    return response.json();
})
.then(data => console.log(data))
.catch(error => console.error("Error:", error));

Valeurs de retour de l'API

Le contenu des réponses de l'API résulte de :
- les données auxquelles vous avez souscrit (pays, vacances, congés scolaires, années civiles)
- les données officiellement connues des législateurs
- la disponibilité en fonction de nos recherches (situation réelle de notre base de données)

Veuillez noter que la version en format CSV diffère.

Array				Explication	Exemple
interface				Version de l'API
source:	href			URL de la source de données (site web)
	description			Nom de la source des données
copyright	href			URL du titulaire du droit d'auteur (site web)
	description			Désignation du titulaire du droit d'auteur
apiName				Identification de l'API	CheckDate/CH/BFS
apiStatus	description			Désignation du statut de l'API. Pour les variantes, voir les Messages d'erreur	active
date				Date d'exportation des données	01.05.2025
request:	bfs			N° OFS de la commune	261
	date			Date des données dans la sortie	2019-04-15
	charset			Codage de la police de la sortie	utf-8
	format			Format des données de la sortie	json
	date_format			Format de la date de la sortie	d.m.Y
	hl			Langue de délivrance, selon la demande	fr
results	status	description		Statut de la confirmation. Pour les variantes, voir les Messages d'erreur	ok
	location	description		Nom de l'unité géographique	Bienne
		type		Désignation du type d'unité géographique	commune
		geoId		Géo-ID de l'unité géographique.	424
		iso		Code pays ISO, 2 chiffres	CH
		iso-3166-2		Code de région selon la norme ISO 3166-2	CH-BE
		note		Notes spéciales
		date_status		Statut du jour
			date	Date	2019-04-15
			total_population	Nombre total d'habitants	54640
			public_holiday_population	Nombre d'habitants ayant un jour férié	0
			public_holiday_percent	Pourcentage d'habitants ayant un jour férié	0
			public_holiday_description	Désignation du jour férié
			school_holiday_population	Nombre d'habitants ayant des vacances scolaires	54640
			school_holiday_percent	Pourcentage de la population ayant des vacances scolaires	100
			school_holiday_description	Désignation Vacances scolaires	Vacances de printemps
			sum_population	Nombre total d'habitants concernés	54640
			percent_population	Pourcentage d'habitants touchés	100

Exemples (JSON / XML / CSV)

JSON

URL :
https://www.feiertagskalender.ch/api/CheckDate/CH/BFS/index.php?api_key=YOUR_API_KEY&bfs=261&date=2025-12-25

Réponse de l'API :

{
    "interface": "fcal API 2.02",
    "source": {
        "href": "https://feiertagskalender.ch",
        "description": "feiertagskalender.ch"
    },
    "copyright": {
        "href": "https://psc.ch",
        "description": "psc Peter Schuetz Informatik-Dienstleistungen, CH Arch"
    },
    "apiName": "CheckDate/CH/BFS",
    "apiStatus": {
        "description": "active"
    },
    "date": "2025-02-25",
    "request": {
        "bfs": "261",
        "date": "2025-12-25",
        "charset": "utf-8",
        "format": "json",
        "date_format": "Y-m-d",
        "hl": "de"
    },
    "results": {
        "status": {
            "description": "ok"
        },
        "location": {
            "description": "Zürich",
            "type": "Stadt",
            "geoId": "3055",
            "iso": "CH",
            "iso-3166-2": "CH-ZH",
            "note": "",
            "date_status": {
                "date": "2025-12-25",
                "total_population": 433989,
                "public_holiday_population": 433989,
                "public_holiday_percent": 100,
                "public_holiday_description": "Weihnachten",
                "school_holiday_population": 0,
                "school_holiday_percent": 0,
                "school_holiday_description": null,
                "sum_population": 433989,
                "sum_percent": 100
            }
        }
    }
}

XML

URL :
https://www.feiertagskalender.ch/api/CheckDate/CH/BFS/index.php?api_key=YOUR_API_KEY&bfs=261&date=2025-12-25&format=XML

Réponse de l'API :

<fcal_api>
<interface>fcal API 2.01</interface>
<source>
<href>https://feiertagskalender.ch</href>
<description>feiertagskalender.ch</description>
</source>
<copyright>
<href>https://psc.ch</href>
<description>psc Peter Schuetz Informatik-Dienstleistungen, CH Bern</description>
</copyright>
<apiStatus>
<description>active</description>
</apiStatus>
<apiName>CheckDate/CH/BFS</apiName>
<date>2025-02-25</date>
<request>
<bfs>261</bfs>
<date>2025-12-25</date>
<charset>utf-8</charset>
<format>xml</format>
<date_format>Y-m-d</date_format>
<hl>de</hl>
</request>
<results>
<status>
<description>ok</description>
</status>
<location>
<description>Zürich</description>
<type>Stadt</type>
<geoId>3055</geoId>
<iso>CH</iso>
<iso-3166-2>CH-ZH</iso-3166-2>
<note></note>
<date_status>
<date>2025-12-25</date>
<total_population>433989</total_population>
<public_holiday_population>433989</public_holiday_population>
<public_holiday_percent>100</public_holiday_percent>
<public_holiday_description>Weihnachten</public_holiday_description>
<school_holiday_population>0</school_holiday_population>
<school_holiday_percent>0</school_holiday_percent>
<school_holiday_description></school_holiday_description>
<sum_population>433989</sum_population>
<sum_percent>100</sum_percent>
</date_status>
</location>
</results>
</fcal_api>

CSV

URL :
https://www.feiertagskalender.ch/api/CheckDate/CH/BFS/index.php?api_key=YOUR_API_KEY&bfs=261&date=2025-12-25&format=csv

Réponse de l'API :

"location";"bfs";"iso";"iso-3166-2";"date";"total_population";"public_holiday_population";"public_holiday_percent";"public_holiday_description";"school_holiday_population";"school_holiday_percent";"school_holiday_description";"sum_population";"sum_percent"
"Zürich";"261";"CH";"CH-ZH";"2025-12-25";"433989";"433989";"100";"Weihnachten";"0";"0";"";"433989";"100"

Messages d'erreur

Emplacement de la sortie	Message d'erreur	Explication
results: status:
results: status: description	not subscribed	Vous n'avez pas souscrit aux données souhaitées.
results: status: description	unknown location	Le numéro de la municipalité FSO demandé n'est pas connu. Veuillez vérifier le paramètre bfs
apiStatus
apiStatus: description	invalid usage	L'utilisation de cette API n'est pas activée pour cet utilisateur.
apiStatus: description	invalid key	Clé API invalide.
apiStatus: description	invalid referer	Accès non valable. Les liens à partir de pages web (front-ends) ne sont pas autorisés.
apiStatus: description	inactive	L'API n'a pas encore été activée pour l'utilisation.
apiStatus: description	expired	La période d'utilisation prévue par le contrat a expiré.

Espace développeurs

Données quotidiennes

Lire le statut du jour par date

API: CheckDate/CH/BFS

Fonction

Guide interactif et OpenAPI

Chapitres de l'API

URL pour les requêtes

Paramètres des requêtes

Exemples (URL / PHP / Python / JavaScript)

Valeurs de retour de l'API

Exemples (JSON / XML / CSV)

JSON

XML

CSV

Messages d'erreur

Pages

plus de psc Informatik

Feiertagskalender.ch

Soutenir le calendrier des jours fériés