Salta ai contenuti

Chiavi API

Le chiavi API vengono utilizzate per autorizzare l’accesso all’API e devono essere incluse con ogni richiesta. Esistono due tipi di chiavi API:

Chiavi API Gratuite

Le Chiavi API Gratuite possono essere create gratuitamente, offrendo un accesso limitato all’API.

Condizioni per l’utilizzo delle Chiavi API Gratuite:

Generazione di una Chiave API Gratuita

Le Chiavi API Gratuite sono legate a un nome dominio specifico e funzionano solo su siti web ospitati sul nome dominio fornito.

Generare una Chiave API Gratuita
Se stai utilizzando un numero di porta non standard, inserisci il nome di dominio e la porta in questo formato: esempio.com:3000.

Il server genererà una nuova Chiave API Gratuita e un segreto:

{
"hostname": "example.com",
"apiKey": "ckey_49960de...",
"secret": "csec_55de16dde79f94...",
"license": "..."
}

Il segreto csec_... viene utilizzato per la verifica del payload (come segreto HMAC) e deve rimanere confidenziale, mai esposto pubblicamente.

Consultare la documentazione per apprendere come generare una nuova Chiave API utilizzando l’API.

Verifica del Dominio

Anche se facoltativa, si consiglia vivamente la verifica del dominio. Verificare la proprietà del proprio nome di dominio tramite il record DNS TXT configurato con il valore fornito altcha-verification=... aggiunge un ulteriore livello di sicurezza.

La verifica del dominio garantisce che la tua Chiave API sia correttamente associata al nome di dominio con cui è destinata a funzionare.

Per verificare il tuo nome di dominio, segui questi passaggi:

  1. Accedi al pannello di gestione dei record DNS.
  2. Aggiungi un record TXT con i seguenti dettagli:
    • Tipo di Record: TXT
    • Host/Nome: @ (o il tuo nome di dominio)
    • Valore/Testo: altcha-verification=abc... (sostituisci abc... con il tuo token di verifica univoco ottenuto quando hai generato la Chiave API)
  3. Salva le modifiche.

Una volta che il record DNS è stato aggiunto e propagato con successo, verrà verificata la proprietà del dominio. Ciò assicura l’uso sicuro della tua Chiave API con il nome di dominio specificato.

Attribuzione per le Chiavi API Gratuite

Quando utilizzi la Chiave API Gratuita, DEVI visualizzare “Protetto da ALTCHA” insieme al logo nel widget (cioè non utilizzare hidelogo o hidefooter). Se non stai utilizzando il widget, DEVI includere un’attribuzione nel piè di pagina del tuo sito web, almeno sulla homepage:

<a href="https://altcha.org">Protetto da ALTCHA</a>

Puoi tradurre o modificare il testo, ma deve trasmettere un significato simile a “Protetto da ALTCHA”. Il link deve dirigere a https://altcha.org e non dovrebbe includere rel="nofollow".

Chiavi API a Pagamento

I piani a pagamento per l’API sono disponibili nell’applicazione Forms. Tutti i piani SaaS concedono l’accesso sia all’API del Filtro Anti-Spam che ai Moduli. In alternativa, è possibile optare per piani Solo AntiSpam, che offrono l’accesso all’API senza Moduli.

Per ottenere accesso pagato all’API, seguire questi passaggi:

  1. Registrarsi per un nuovo account su ALTCHA Forms su eu.altcha.org per i clienti dell’UE o us.altcha.org per i clienti statunitensi.
  2. All’interno dell’applicazione, andare su Impostazioni dell’account -> Fatturazione e selezionare il piano desiderato.
  3. Completare il processo di acquisto.
  4. Generare una nuova chiave API dentro Impostazioni dell’account -> Chiavi API.