Documentazione API

Controllo delle funzioni API

Controlla lo stato della vostra chiave API

Set di dati con lo stato della vostra chiave API.

API: api_key

Capitoli:

API: api_key

Funzione

Visualizza lo stato della chiave API.

URL per le richieste

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

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 di data desiderato
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

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

Messaggi di errore

Posizione di uscita Messaggio di errore Spiegazione
apiStatus
apiStatus: description invalid usage L'uso di questa API non è sbloccato per voi.
Si prega di contattare il nostro supporto.
apiStatus: description invalid key Chiave API non valida.
Si prega di controllare la chiave API.
apiStatus: description invalid referer Accesso non valido. Non sono ammessi link da pagine web (front-end).
Impostate la vostra richiesta in modo che provenga da un back-end protetto.
Se necessario, contattare il nostro supporto.
apiStatus: description inactive L'API non è ancora stata abilitata all'uso.
Si prega di riprovare in un secondo momento.
apiStatus: description expired Il periodo di utilizzo secondo il contratto è scaduto.
Contattate la nostra amministrazione per un prolungamento del contratto.

Esempi

JSON

URL:
https://feiertagskalender.ch/api/api_key/?api_key=YOUR_API_KEY

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 Bern"
	},
	"apiName": "api_key",
	"date":"2022-07-06",
	"apiKeyStatus": "active",
	"apiDateStart": "2014-06-01",
	"apiDateEnd": "2023-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"
	}]
}

XML

URL:
https://feiertagskalender.ch/api/api_key/?api_key=YOUR_API_KEY&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>2022-07-06</date>
	<apiName>api_key</apiName>
	<apiKeyStatus>active</apiKeyStatus>
	<apiDateStart>2014-06-01</apiDateStart>
	<apiDateEnd>2022-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>                  

CSV

Aufruf:
https://feiertagskalender.ch/api/api_key/?api_key=YOUR_API_KEY&format=csv

Risposta delle 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"
©2003 - 2022 psc Peter Schütz Informatik Dienstleistungen, CH-Arch