Documentazione API

Controllo delle funzioni API

API: api_key

Funzione

Visualizza lo stato della chiave API.


Guida interattiva e OpenAPI aperta

OpenAPI 3.0 (Swagger) – Documentazione API interattiva

Apre la documentazione interattiva dell'API con Swagger, dove è possibile testare ed esplorare gli endpoint dell'API.

Scarica le specifiche JSON di OpenAPI

URL per le richieste

Per recuperare i dati, utilizzare il seguente URL. Si prega di prestare attenzione alle maiuscole e alle minuscole.

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

Parametri per le richieste

Con le seguenti variabili è possibile completare la query e controllare i risultati delle API.

Parametro Spiegazione Esempi
api_key
richiesto
La vostra chiave API api_key=abc-123-def-456
charset

La codifica desiderata della risposta

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

charset=iso-8859-1
format

Il formato di uscita desiderato

Varianti:
JSON (= Standard)
XML
CSV

format=xml
date_format

Il formato della data desiderato per la risposta. Standard:`Y-m-d` (ad esempio, 2025-12-31).
Il formato corrisponde alla formattazione della data dell'istruzione PHP date()

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

Esempi (URL / PHP / Python / JavaScript)

Mostra esempi

Valori di ritorno dell'API

Array         Spiegazione Esempio
interface         Versione dell'API  
source: href       URL della fonte dei dati (sito web)  
  description       Nome della fonte dei dati  
copyright href       URL al titolare del copyright (sito web)  
  description       Designazione del titolare del diritto d'autore  
apiName         Identificazione dell'API api_key
date         Data di esportazione dei dati 01.05.2025
apiKeyStatus         Stato dell'output. Per le varianti, vedere i Messaggi di errore active
apiDateStart         Data accesso API abilitato 01.01.2015
apiDateEnd         Data di scadenza del contratto di accesso API 31.12.2018
apiData            
  dataPublicHolidays       Portata dei paesi sottoscritti per i giorni festivi

Opzioni
- all
- Codice ISO del paese, 2 cifre, virgola separata
AT,CH,DE
  yearsPublicHolidays       Portata degli anni sottoscritti per i giorni festivi 2015,2016,2017,2018
  dataSchoolHolidays      

Portata dei paesi sottoscritti per le vacanze scolastiche

Opzioni
- all
- Codice ISO del paese, 2 cifre, virgola separata

CH
  yearsSchoolHolidays       Volume di anni di abbonamento per le vacanze scolastiche 2015,2016,2017,2018
apiList api       Elenco di tutte le API abilitate per voi  

Esempi (JSON / XML / CSV)

JSON

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

Risposta delle 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 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

Risposta delle 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>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

Risposta delle API:

"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"

Messaggi di errore

Posizione di uscita Messaggio di errore Spiegazione
apiStatus
apiStatus: description invalid usage L'uso di questa API non è abilitato per questo utente.
apiStatus: description invalid key Chiave API non valida.
apiStatus: description invalid referer Accesso non valido. Non sono ammessi link da pagine web (front-end).
apiStatus: description inactive L'API non è ancora stata attivata per l'uso.
apiStatus: description expired Il periodo di utilizzo secondo il contratto è scaduto.
© 2003 - 2025 psc Peter Schütz Informatik Dienstleistungen, CH-Arch