Documentazione API

Autenticazione

Autenticazione API

Tutte le richieste API richiedono autenticazione utilizzando una chiave API. Questa guida spiega come creare, gestire e utilizzare le chiavi API in modo sicuro.

Ottenere una Chiave API

Per ottenere una chiave API, devi avere un account iloveQR e far parte di un'organizzazione.

Accedi al tuo account

Accedi o crea un account se non ne hai uno.

Naviga alla pagina Sviluppatori

Vai a Dashboard → Sviluppatori per gestire le tue chiavi API.

Crea una nuova chiave API

Clicca su 'Crea Chiave API', dai un nome descrittivo e conserva in modo sicuro la chiave generata.

Utilizzando la Tua Chiave API

Includi la tua chiave API nell'intestazione X-API-Key con ogni richiesta:

Intestazione della Richiesta

curl -X GET \
  https://api.iloveqr.com/api/v1/organizations/YOUR_ORG_ID/qr-codes \
  -H "X-API-Key: ilqr_your_api_key_here" \
  -H "Content-Type: application/json"

ID Organizzazione

La maggior parte degli endpoint API richiede un ID organizzazione nel percorso URL. Puoi trovare il tuo ID organizzazione nelle impostazioni del dashboard o facendo una richiesta all'endpoint delle organizzazioni.

Ottieni le Tue Organizzazioni

curl -X GET \
  https://api.iloveqr.com/api/v1/users/me/organizations \
  -H "X-API-Key: ilqr_your_api_key_here"

Risposta

{
  "organizations": [
    {
      "id": "org_abc123",
      "name": "My Company",
      "slug": "my-company",
      "role": "ADMIN"
    }
  ]
}

Migliori Pratiche di Sicurezza

Non esporre mai le chiavi API nel codice lato client

Effettua sempre chiamate API dal tuo server. Non includere mai le chiavi API in JavaScript che viene eseguito nel browser, nelle app mobili o in qualsiasi codice che può essere visualizzato dagli utenti.

Utilizza variabili d'ambiente

Conserva le tue chiavi API in variabili d'ambiente, non nel tuo codice sorgente. Questo previene esposizioni accidentali attraverso il controllo di versione.

Ruota le chiavi regolarmente

Crea nuove chiavi API periodicamente e revoca quelle vecchie. Se sospetti che una chiave sia stata compromessa, revocala immediatamente.

Errori di Autenticazione

Quando l'autenticazione fallisce, l'API restituisce una di queste risposte di errore:

Codice di Stato	Errore	Descrizione
401	UNAUTHORIZED	Chiave API mancante o non valida
403	FORBIDDEN	La chiave API non ha permesso per questa azione
403	API_KEY_REVOKED	La chiave API è stata revocata

Esempio di risposta errore

{
  "statusCode": 401,
  "message": "Invalid or missing API key",
  "error": "Unauthorized"
}

Prossimi passi

Ora che comprendi l'autenticazione, scopri come utilizzare l'API: