Le API Key

Le funzioni descritte in questa pagina sono disponibili solo per l'admin

Le API Key

Le API Key permettono di abilitare le API per inviare messaggi ai cittadini in modo automatico. L'amministratore può creare nuove chiavi e revocare quelle esistenti dalla sezione Utenti → API Key.

E' possibile creare una nuova chiave da Crea nuova API Key o revocarne di esistenti. La revoca interrompe immediatamente qualsiasi integrazione.

Attenzione

Al momento della creazione, la chiave API viene mostrata una sola volta e non è possibile recuperarla. Ricordati di copiarla e conservarla in un luogo sicuro; se la chiave viene persa, l'unica soluzione è revocarla e crearne una nuova.

Documentazione API

La documentazione API è costituita dagli endpoint REST disponibili per ogni servizio attivo sulla piattaforma. La documentazione si genera automaticamente in base ai servizi e agli eventi configurati.

Le API di OC Connect sono protette da autenticazione e per utilizzarle è necessario configurare un'API key come descritto nel paragrafo "Le API Key".

Clicca qui per leggere la documentazione completa

Cosa è possibile fare

Tramite API è possibile inviare messaggi ai cittadini in modo automatico, a partire dalle configurazioni già definite nella piattaforma. Per ogni messaggio viene utilizzato il template predefinito associato all'evento, ma è possibile specificarne uno diverso se necessario.

I messaggi inviati tramite API sono visibili sia attraverso le API stesse sia direttamente nell'interfaccia della piattaforma, dove compaiono insieme a quelle inviate manualmente.

Le API supportano un meccanismo di idempotenza: è possibile associare a ogni richiesta una chiave univoca. Se la stessa chiave viene inviata più volte, la piattaforma riconosce la duplicazione e blocca gli invii successivi, garantendo che il cittadino riceva il messaggio una volta sola.