Kapitel:
Gibt den Status Ihres API-Keys aus.
Zum Abrufen der Daten verwenden Sie folgende URL. Achten Sie bitte auf Gross-Kleinschrift.
Mit den folgenden Variablen können Sie die Abfrage vervollständigen und die API-Ergebnisse steuern.
Parameter | Erläuterung | Beispiele |
---|---|---|
api_key erforderlich |
Ihr API-Key |
?api_key=abc-123-def-456 |
charset | Die gewünschte Codierung der Antwort Varianten: |
&charset=iso-8859-1 |
format | Das gewünschte Ausgabeformat Varianten: |
&format=xml |
date_format | Das gewünschte Datumformat Varianten: |
&date_format=d.m.Y |
Array | Erläuterung | Beispiel | ||||
---|---|---|---|---|---|---|
interface | Version des API | |||||
source: | href | URL zur Datenquelle (Website) | ||||
description | Bezeichnung der Datenquelle | |||||
copyright | href | URL zum Inhaber des Copyrights (Website) | ||||
description | Bezeichnung des Copyright-Inhabers | |||||
apiName | Identifikation des API | api_key | ||||
date | Datum des Datenexports | 24.04.2024 | ||||
apiKeyStatus | Status der Ausgabe. Für Varianten, siehe unter Fehlermeldungen | active | ||||
apiDateStart | Datum Freischaltung des API-Zugriffs | 01.01.2015 | ||||
apiDateEnd | Datum Vertragsende des API-Zugriffs | 31.12.2018 | ||||
apiData | ||||||
dataPublicHolidays | Umfang der abonnierten Länder für Feiertage Optionen - all - ISO-Landeskürzel, 2-stellig, kommasepariert |
AT,CH,DE | ||||
yearsPublicHolidays | Umfang der abonnierten Jahre für Feiertage | 2015,2016,2017,2018 | ||||
dataSchoolHolidays | Umfang der abonnierten Länder für Schulferien Optionen |
CH | ||||
yearsSchoolHolidays | Umfang der abonnierten Jahre für Schulferien | 2015,2016,2017,2018 | ||||
apiList | api | Liste aller für Sie freigeschaltenen APIs |
Art der Ausgabe | Fehlermeldung | Erläuterung |
---|---|---|
apiStatus | ||
apiStatus: description | invalid usage | Die Verwendung dieses API ist für Sie nicht freigeschaltet. Wenden Sie sich bitte an unseren Support. |
apiStatus: description | invalid key | Ungültiger API-Key. Prüfen Sie bitte Ihren API-Key. |
apiStatus: description | invalid referer | Ungültiger Zugriff. Links ab Webseiten (Front-Ends) sind nicht zulässig. Richten Sie Ihre Abfrage so ein, dass diese aus einem geschützten Back-End erfolgt. Wenden Sie sich allenfalls an unseren Support. |
apiStatus: description | inactive | Das API wurde für Sie noch nicht zur Benutzung freigeschaltet. Versuchen Sie es bitte zu einem späteren Zeitpunkt noch einmal. |
apiStatus: description | expired | Die Nutzungsdauer nach Vertrag ist abgelaufen. Wenden Sie sich für eine Vertragsverlängerung an unsere Administration. |
URL:
https://feiertagskalender.ch/api/api_key/?api_key=YOUR_API_KEY
Antwort des APIs:
{ "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-24", "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
Antwort des APIs:
<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-24</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
Antwort des APIs:
"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"