Cos'è una API Key?

Cos'è una API key

Cos'è una API Key? Guida Semplice con Checklist di Sicurezza | We.Inc

Cos'è una API key, come si distingue da una password o da un token OAuth, dove conservarla, come limitarla e ruotarla, e cosa fare appena una viene esposta.

Una API key è una lunga stringa segreta che un programma invia con ogni richiesta per dimostrare quale account sta chiamando un servizio, come un provider di pagamenti, mappe o email. Tratta la maggior parte delle chiavi come una password: tienile su un server, mai nel codice del sito, limita cosa possono fare e sostituiscile se vengono esposte.

API key, token di accesso OAuth e password a confronto

  • API key
  • Token di accesso OAuth
  • Password
  • Chi la usa
  • Il tuo codice o il tuo server
  • Un'app che agisce per conto di un utente che l'ha autorizzata
  • Una persona che accede
  • Come la ottieni
  • La copi dalla dashboard del provider
  • Emesso dopo che l'utente fa clic su Consenti
  • Scelta dalla persona
  • Durata tipica
  • Finché non la ruoti o la elimini
  • Breve, poi rinnovato
  • Finché non viene cambiata
  • Ambito
  • Quello che hai consentito al momento della creazione
  • I permessi concessi dall'utente
  • Tutto ciò che l'account può fare

Se gestisci un sito web o un negozio, incontri le API key ogni volta che colleghi un servizio: pagamenti, mappe, email, uno strumento per moduli o un agente AI. La maggior parte sono segrete, alcune sono pensate per essere pubbliche, e confonderle è il modo in cui nascono bollette salate e fughe di dati. Incolla una chiave nell'analizzatore qui sotto per vedere di che tipo sembra; funziona interamente nel tuo browser e non invia nulla da nessuna parte.

  • Crei la chiave nella dashboard del provider e la copi una volta; molti provider non la mostrano mai più.
  • Il tuo server la conserva in una variabile d'ambiente o nelle impostazioni dei secret dell'hosting.
  • Ogni richiesta al provider porta con sé la chiave, di solito in un header Authorization.
  • Il provider cerca la chiave, controlla cosa le è consentito fare e risponde o rifiuta.
  • Non incollare mai una chiave segreta nel codice front-end, in un repository pubblico, in una chat di assistenza o in un'email.
  • Usa chiavi con restrizioni quando sono disponibili. Stripe, per esempio, consiglia chiavi con restrizioni che abbiano solo i permessi necessari a un'integrazione.
  • Aggiungi restrizioni come siti web, indirizzi IP o API specifiche consentiti, così una chiave rubata vale meno.
  • Elimina le chiavi che non usi più e ruota le altre a intervalli regolari, e quando se ne va qualcuno che aveva accesso.
  • Tieni separate le chiavi di test e quelle live. Molti provider le distinguono nel prefisso, come sk_test_ e sk_live_.

Domande frequenti

Una API key è la stessa cosa di una password?

Sono entrambe segrete, ma una password serve a una persona per accedere mentre una API key serve a un software per chiamare un servizio. Le chiavi sono lunghe e casuali, di solito limitate a certe azioni, e si possono sostituire senza cambiare il login di nessuno.

Posso mettere una API key nel JavaScript del mio sito?

Solo se il provider dice che quel tipo di chiave si può esporre. Le chiavi pubblicabili di Stripe che iniziano con pk_ sono pensate per il codice front-end; le sue chiavi segrete e con restrizioni no. Tutto ciò che sta nel browser può essere letto da ogni visitatore.

Dove devo conservare le API key?

In un vault per i secret o nelle impostazioni delle variabili d'ambiente del tuo hosting. Sia Stripe sia Google dicono di non mettere le chiavi nel codice sorgente né di committarle nei repository di codice.

Cosa devo fare se la mia API key è stata esposta?

Revocala o ruotala subito nella dashboard del provider, poi metti la nuova chiave nelle impostazioni del tuo server. L'indicazione di GitHub sui secret rilevati è di ruotare immediatamente la credenziale coinvolta; ripulire solo la cronologia non rende sicura una chiave ancora attiva.

API key o OAuth?

Usa una API key quando il tuo server comunica con un servizio sul tuo account. Usa OAuth quando la tua app deve agire per conto di altre persone sui loro account, perché in quel caso ognuna concede l'accesso e può revocarlo da sola.

Chiavi pubbliche e chiavi segrete

  • Alcuni servizi rilasciano una coppia. Una chiave pubblicabile identifica il tuo account dal browser ma non può fare nulla di sensibile, mentre la chiave segreta sul tuo server può addebitare carte o leggere dati. La documentazione di Stripe indica solo la chiave pubblicabile come sicura da esporre.
  • Anche una chiave per il browser va limitata. L'indicazione di Google Cloud è di aggiungere restrizioni alla API key, che limitano i modi in cui una chiave può essere usata e quindi riducono il danno se qualcuno la copia.

Checklist per una chiave esposta

  • Primo, ruota o elimina la chiave nella dashboard del provider. Secondo, aggiorna la nuova chiave in ogni punto in cui si usava quella vecchia. Terzo, controlla nei log di utilizzo del provider eventuali chiamate che non hai fatto tu. Quarto, scopri come è uscita, per esempio da un file committato o da un bundle front-end, e chiudi quella falla.

Usare una chiave in sicurezza da un server

La chiave vive in una variabile d'ambiente sul server. Il browser chiama il tuo endpoint, che aggiunge la chiave e chiama il provider.

.env (mai committato)

Solo valori segnaposto. Aggiungi .env a .gitignore così non arriva mai nel tuo repository.

Una piccola route server. Il secret viene letto sul server e non viene mai inviato al browser.

Analizzatore di API key

Incolla una chiave o solo i suoi primi caratteri. Il controllo avviene solo nel tuo browser; meglio comunque usare una chiave di test o un valore fittizio invece di un secret live.

Chiave da analizzare

Chiave pubblicabile Stripe

Chiave segreta Stripe

Chiave Stripe con restrizioni

Token Notion

Secret di firma del webhook (prefisso whsec_)

Nessun prefisso noto. Trattala come segreta a meno che il provider non dica altrimenti.

Pensata per il codice front-end, secondo il provider.

Segreta: tienila su un server, mai in una pagina web.

Chiave in modalità test o sandbox.

Chiave in modalità live: soldi veri o dati reali.

Lunghezza: {n} caratteri

Casualità approssimativa se generata in modo casuale: {n} bit

Sembra corta per un secret. Circa {n} bit o più è un obiettivo approssimativo ragionevole.

Incolla qualcosa da analizzare.

Inizia gratis · Nessuna carta di credito richiesta

Correlati: Guide

Prodotto

Per chi è

Funzionalità

Risorse

Azienda

Mappa del sito