API-Dokumentation

API-Funktionskontrolle

API: api_key

Funktion

Gibt den Status Ihres API-Keys aus.


Interaktive Anleitung und OpenAPI

OpenAPI 3.0 (Swagger) – Interaktive API-Dokumentation

Öffnet die interaktive API-Dokumentation mit Swagger, in der Sie API-Endpunkte testen und erkunden können.

OpenAPI JSON-Spezifikation herunterladen

URL für Anfragen

Zum Abrufen der Daten verwenden Sie folgende URL. Achten Sie bitte auf Gross-Kleinschrift.

POST / GET
https://feiertagskalender.ch/api/api_key/index.php

Parameter für Anfragen

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-Schlüssel api_key=abc-123-def-456
charset

Die gewünschte Codierung der Antwort

Varianten:
UTF-8 (= Standard)
ISO-8859-1

charset=iso-8859-1
format

Das gewünschte Ausgabeformat

Varianten:
JSON (= Standard)
XML
CSV

format=xml
date_format

Das gewünschte Datumsformat für die Antwort. Standard:`Y-m-d` (z.B., 2025-12-31)
Das Format entspricht der Datumsformatierung der PHP-Anweisung date()

Varianten:
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

Beispiele (URL / PHP / Python / JavaScript)

Beispiele anzeigen

Rückgabewerte des API

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 01.05.2025
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
- all
- ISO-Landeskürzel, 2-stellig, kommasepariert

CH
  yearsSchoolHolidays       Umfang der abonnierten Jahre für Schulferien 2015,2016,2017,2018
apiList api       Liste aller für Sie freigeschaltenen APIs  

Beispiele (JSON / XML / CSV)

JSON

URL:
https://www.feiertagskalender.ch/api/api_key/index.php?api_key=YOUR_API_KEY&date_format=Y-m-d

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 Arch"
    },
    "apiName": "api_key",
    "date": "2025-02-26",
    "apiKeyStatus": "active",
    "apiDateStart": "2021-03-31",
    "apiDateEnd": "2026-03-31",
    "apiData": {
        "dataPublicHolidays": "AT,CH,DE,LI",
        "yearsPublicHolidays": "2020,2021,2022,2023,2024,2025,2026",
        "dataSchoolHolidays": "AT,CH,DE,LI",
        "yearsSchoolHolidays": "2020,2021,2022,2023,2024,2025,2026"
    },
    "apiList": [
        {
            "api": "api_key"
        },
        {
            "api": "CheckDate/CH/BFS"
        },
        {
            "api": "CheckDate/CH/PLZ"
        },
        {
            "api": "CheckDate/GeoId"
        },
        {
            "api": "Data/Aggreg"
        },
        {
            "api": "Data/CH/BFS"
        },
        {
            "api": "Data/CH/Kanton"
        },
        {
            "api": "Data/CH/PLZ"
        },
        {
            "api": "Data/Country"
        },
        {
            "api": "Data/Country/CH"
        },
        {
            "api": "Data/Country/CH/PLZ"
        },
        {
            "api": "Data/Country/LI"
        },
        {
            "api": "Data/Country/LI/PLZ"
        },
        {
            "api": "Data/GeoId"
        },
        {
            "api": "GeoTree/CH"
        },
        {
            "api": "GeoTree/ISO"
        }
    ]
}

XML

URL:
https://www.feiertagskalender.ch/api/api_key/index.php?api_key=YOUR_API_KEY&date_format=Y-m-d&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>2025-02-26</date>
<apiName>api_key</apiName>
<apiKeyStatus>active</apiKeyStatus>
<apiDateStart>2021-03-31</apiDateStart>
<apiDateEnd>2026-03-31</apiDateEnd>
<apiData>
<dataPublicHolidays>AT,CH,DE,LI</dataPublicHolidays>
<yearsPublicHolidays>2020,2021,2022,2023,2024,2025,2026</yearsPublicHolidays>
<dataSchoolHolidays>AT,CH,DE,LI</dataSchoolHolidays>
<yearsSchoolHolidays>2020,2021,2022,2023,2024,2025,2026</yearsSchoolHolidays>
</apiData>
<apiList>
<api>api_key</api>
<api>CheckDate/CH/BFS</api>
<api>CheckDate/CH/PLZ</api>
<api>CheckDate/GeoId</api>
<api>Data/Aggreg</api>
<api>Data/CH/BFS</api>
<api>Data/CH/Kanton</api>
<api>Data/CH/PLZ</api>
<api>Data/Country</api>
<api>Data/Country/CH</api>
<api>Data/Country/CH/PLZ</api>
<api>Data/Country/LI</api>
<api>Data/Country/LI/PLZ</api>
<api>Data/GeoId</api>
<api>GeoTree/CH</api>
<api>GeoTree/ISO</api>
</apiList>
</fcal_api>

CSV

Aufruf:
https://www.feiertagskalender.ch/api/api_key/index.php?api_key=YOUR_API_KEY&date_format=Y-m-d&format=csv

Antwort des APIs:

"interface";"apiKeyStatus";"apiDateStart";"apiDateEnd";"dataPublicHolidays";"yearsPublicHolidays";"dataSchoolHolidays";"yearsSchoolHolidays";"api"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"api_key"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"CheckDate/CH/BFS"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"CheckDate/CH/PLZ"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"CheckDate/GeoId"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"Data/Aggreg"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"Data/CH/BFS"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"Data/CH/Kanton"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"Data/CH/PLZ"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"Data/Country"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"Data/Country/CH"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"Data/Country/CH/PLZ"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"Data/Country/LI"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"Data/Country/LI/PLZ"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"Data/GeoId"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"GeoTree/CH"
"fcal API 2.0";"active";"2021-03-31";"2026-03-31";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"AT,CH,DE,LI";"2020,2021,2022,2023,2024,2025,2026";"GeoTree/ISO"

Fehlermeldungen

Art der Ausgabe Fehlermeldung Erläuterung
apiStatus
apiStatus: description invalid usage Die Verwendung dieses API ist für diesen Nutzer nicht freigeschaltet.
apiStatus: description invalid key Ungültiger API-Schlüssel.
apiStatus: description invalid referer Ungültiger Zugriff. Links ab Webseiten (Front-Ends) sind nicht zulässig.
apiStatus: description inactive Das API wurde für noch nicht zur Benutzung freigeschaltet.
apiStatus: description expired Die Nutzungsdauer nach Vertrag ist abgelaufen.
© 2003 - 2025 psc Peter Schütz Informatik Dienstleistungen, CH-Arch