Una chiave API è una credenziale segreta che ti permette di chiamare l’API REST della Piattaforma dal tuo codice (uno script, un backend, un CRM esterno…) senza passare dal modulo di accesso: invece di email e password, la tua integrazione invia la chiave in ogni richiesta HTTP. È il meccanismo pensato per integrazioni M2M (macchina a macchina) — automazioni, sincronizzazioni con altri sistemi, script interni della tua attività — mai perché una persona acceda con essa all’interfaccia web della Piattaforma stessa.
Cosa sono le chiavi API e a cosa servonoUna chiave API è una credenziale segreta che ti permette di chiamare l'API REST della Piattaforma dal tuo codice (uno script, un backend, un CRM esterno…) senza passare dal modulo
I due tipi di chiaveLa Piattaforma distingue due tipi di chiave secondo il loro proprietario.
Requisiti preliminariAbbonamento attivo della tua agenzia (una chiave con l'account bloccato per fatturazione non può essere
Procedura: creare una chiave personaleRequisiti: nessuno in particolare — qualsiasi ruolo può creare chiavi per sé stesso.
Procedura: creare una chiave dell'aziendaRequisiti: ruolo Admin.
Origini consentiteOgni chiave ha un elenco facoltativo di origini consentite: i domini (hostname) da cui è accettato usarla quando la richiesta arriva con l'intestazione Origin (cioè, da un browser)
Cosa può fare ogni chiave: permessi e il selettore «Personalizza»Nessuna chiave porta permessi «à la carte» per impostazione predefinita: eredita un insieme di permessi già definito, sigillato al momento della creazione (paragrafo 2).
ScadenzaAl momento della creazione della chiave scegli quanto dura: Mai, 30, 90 o 365 giorni.
RevocaNon esiste un «elimina» per la chiave: solo la revoca.
Utilizzo: autenticazione con X-API-KeyUna volta che hai la chiave, autentica ogni richiesta aggiungendo l'intestazione X-API-Key con il valore completo della chiave.
Limiti di richieste (rate limit)Oltre ai limiti generali già applicati a qualsiasi richiesta (per tenant, per utente o per IP, a seconda del caso), ogni richiesta che include l'intestazione X-API-Key riceve una q
Errori comuni e come risolverliCodice · Quando accade · Cosa fare
Buone pratiche di custodiaNon condividerla via chat, email non cifrata, né incollarla in nessun posto pubblico.
Domande frequentiPosso avere più chiavi personali contemporaneamente?