Ensemble de données avec le statut de votre clé API.
Chapitres :
Affiche l'état de votre clé API.
Pour récupérer les données, utilisez l'URL suivante. Veuillez faire attention aux majuscules et aux minuscules.
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 |
| charset | Le codage souhaité de la réponse Variantes : |
&charset=iso-8859-1 |
| format | Le format de sortie souhaité Variantes : |
&format=xml |
| date_format | Le format de date souhaité Variantes : |
&date_format=d.m.Y |
| 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 | api_key | ||||
| date | Date d'exportation des données | 25.04.2024 | ||||
| apiKeyStatus | Statut de la confirmation. Pour les variantes, voir les Messages d'erreur | active | ||||
| apiDateStart | Date d'activation de l'accès à l'API | 01.01.2015 | ||||
| apiDateEnd | Date de fin du contrat d'accès à l'API | 31.12.2018 | ||||
| apiData | ||||||
| dataPublicHolidays | Champ d'application des pays souscrits pour les jours fériés Options - all - Code pays ISO, 2 chiffres, séparé par une virgule |
AT,CH,DE | ||||
| yearsPublicHolidays | Portée des années souscrites pour les jours fériés | 2015,2016,2017,2018 | ||||
| dataSchoolHolidays | Portée des pays souscrits pour les vacances scolaires Options |
CH | ||||
| yearsSchoolHolidays | Volume des années souscrites pour les vacances scolaires | 2015,2016,2017,2018 | ||||
| apiList | api | Liste de toutes les API activées pour vous |
| Emplacement de la sortie | Message d'erreur | Explication |
|---|---|---|
| apiStatus | ||
| apiStatus: description | invalid usage | L'utilisation de cette API n'est pas débloquée pour vous. Veuillez contacter notre service de soutien. |
| apiStatus: description | invalid key | Clé API invalide. Veuillez vérifier votre clé API. |
| apiStatus: description | invalid referer | Accès non valable. Les liens à partir de pages web (front-ends) ne sont pas autorisés. Configurez votre requête de manière à ce qu'elle provienne d'un back-end protégé. Si nécessaire, contactez notre support. |
| apiStatus: description | inactive | L'API n'a pas encore été activée pour que vous puissiez l'utiliser. Veuillez réessayer plus tard. |
| apiStatus: description | expired | La période d'utilisation prévue par le contrat a expiré. Contactez notre administration pour une prolongation de contrat. |
URL :
https://feiertagskalender.ch/api/api_key/?api_key=YOUR_API_KEY
Réponse de l'API :
{
"interface": "fcal API 2.0",
"source": {
"href": "https://feiertagskalender.ch",
"description": "Feiertagskalender.ch"
},
"copyright": {
"href": "https://psc.ch",
"description": "psc Peter Schuetz Informatik-Dienstleistungen, CH Bern"
},
"apiName": "api_key",
"date":"2024-04-25",
"apiKeyStatus": "active",
"apiDateStart": "2014-06-01",
"apiDateEnd": "2025-06-01",
"apiData": {
"dataPublicHolidays": "AT,CH,DE",
"yearsPublicHolidays": "2015,2016,2017,2018,2019,2020",
"dataSchoolHolidays": "AT,CH,DE",
"yearsSchoolHolidays": "2015,2016,2017,2018,2019,2020"
},
"apiList": [{
"api": "api_key"
}, {
"api": "Data/CH/BFS"
}, {
"api": "Data/CH/Kanton"
}, {
"api": "Data/CH/PLZ"
}, {
"api": "Data/CityId"
}, {
"api": "Data/GeoId"
}, {
"api": "GeoTree/ISO"
}]
}
URL :
https://feiertagskalender.ch/api/api_key/?api_key=YOUR_API_KEY&format=xml
Réponse de l'API :
<fcal_api> <interface>fcal API 2.0</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> <date>2024-04-25</date> <apiName>api_key</apiName> <apiKeyStatus>active</apiKeyStatus> <apiDateStart>2014-06-01</apiDateStart> <apiDateEnd>2024-06-01</apiDateEnd> <apiData> <dataPublicHolidays>AT,CH,DE</dataPublicHolidays> <yearsPublicHolidays>2015,2016,2017,2018,2019,2020</yearsPublicHolidays> <dataSchoolHolidays>AT,CH,DE</dataSchoolHolidays> <yearsSchoolHolidays>2015,2016,2017,2018,2019,2020</yearsSchoolHolidays> </apiData> <apiList> <api>api_key</api> <api>Data/CH/BFS</api> <api>Data/CH/Kanton</api> <api>Data/CH/PLZ</api> <api>Data/CityId</api> <api>Data/GeoId</api> <api>GeoTree/ISO</api> </apiList> </fcal_api>
Aufruf:
https://feiertagskalender.ch/api/api_key/?api_key=YOUR_API_KEY&format=csv
Réponse de l'API :
"interface";"apiKeyStatus";"apiDateStart";"apiDateEnd";"dataPublicHolidays";"yearsPublicHolidays";"dataSchoolHolidays";"yearsSchoolHolidays";"api" "fcal API 2.0";"active";"2014-06-01";"2020-05-31";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"api_key" "fcal API 2.0";"active";"2014-06-01";"2020-05-31";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"Data/CH/BFS" "fcal API 2.0";"active";"2014-06-01";"2020-05-31";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"Data/CH/Kanton" "fcal API 2.0";"active";"2014-06-01";"2020-05-31";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"Data/CH/PLZ" "fcal API 2.0";"active";"2014-06-01";"2020-05-31";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"Data/CityId" "fcal API 2.0";"active";"2014-06-01";"2020-05-31";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"Data/GeoId" "fcal API 2.0";"active";"2014-06-01";"2020-05-31";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"AT,CH,DE";"2015,2016,2017,2018,2019,2020";"GeoTree/ISO"