Chiavistello

Documentazione APIAPI documentation

AccessoAccess

  • Ogni richiesta deve includere una chiave API valida nell'header HTTP X-ApiKey; ogni chiave è associata a una singola struttura Chiavistello
  • Il proprietario della struttura fornisce la chiave API all'integratore e può chiedere a Chiavistello di revocarla o rigenerarla in qualsiasi momento
  • Il proprietario trova la chiave API nel pannello di controllo in Configura » Notifiche (se non è presente, chiedere a Chiavistello di abilitare le API)
  • Limite di richieste: ogni chiave API può effettuare fino a 200 richieste al minuto e 600 richieste all'ora (per singola chiave si possono concordare limiti diversi). Ogni risposta autenticata include gli header X-RateLimit-Limit e X-RateLimit-Remaining relativi al minuto in corso; se un limite viene superato l'API risponde 429 Too Many Requests con l'header Retry-After (secondi da attendere prima di riprovare)
  • Dopo più di 5 autenticazioni fallite in 10 minuti dallo stesso indirizzo IP, le richieste successive con chiave non valida vengono rallentate e ricevono 429
  • Every request must include a valid API key in the X-ApiKey HTTP header; each key is bound to a single Chiavistello property
  • The property owner gives the API key to the integrator and can ask Chiavistello to revoke or regenerate it at any time
  • The owner finds the API key in the control panel under Configura » Notifiche (if not present, ask Chiavistello to enable the API)
  • Rate limit: each API key can perform up to 200 requests per minute and 600 requests per hour (different limits can be agreed per key). Every authenticated response includes the X-RateLimit-Limit and X-RateLimit-Remaining headers for the current minute; when a limit is exceeded the API answers 429 Too Many Requests with a Retry-After header (seconds to wait before retrying)
  • After more than 5 failed authentications in 10 minutes from the same IP address, further requests with an invalid key are delayed and answered with 429

REST API (OpenAPI 3.0)

Swagger UI: documentazione e tester interattivoSwagger UI: documentation and interactive tester

Le vecchie API JSON-RPC (legacy) sono deprecate e non più disponibili: usare le API REST. The legacy JSON-RPC API is deprecated and no longer available: use the REST API.

RSS

Integra facilmente le notifiche con un feed RSS privato: aggiungilo nel pannello di controllo in Configura » Notifiche Easily integrate notifications using a private RSS feed: add it in the control panel under Configura » Notifiche