Passa al contenuto principale

Autenticazione

Sono disponibili tre metodi di autenticazione. API Key è consigliata per la maggior parte delle integrazioni.

API Key (Consigliato)

Includi la tua API key nell'header X-Api-Key con ogni richiesta.

Ottenere la tua API Key

  1. Accedi al tuo account Qlara
  2. Vai a ImpostazioniAPI Keys
  3. Genera una nuova key o copia la tua key esistente
  4. Conservala in modo sicuro (non commitarla nel controllo di versione)

Utilizzare API Key

curl -X POST https://lora-api.agiletelecom.com/api/message-server/sms/send \
-H "X-Api-Key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"phoneNumber": "+393901234567",
"message": "Hello from Qlara!"
}'

Autenticazione di Base

Se le API key non sono adatte al tuo caso d'uso, usa credenziali codificate in Base64.

Generare Credenziali di Autenticazione di Base

Su macOS/Linux:

echo -n "username:password" | base64

Su Windows (PowerShell):

[Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("username:password"))

Utilizzare Autenticazione di Base

curl -X POST https://lora-api.agiletelecom.com/api/message-server/sms/send \
-H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
-H "Content-Type: application/json" \
-d '{
"phoneNumber": "+393901234567",
"message": "Hello from Qlara!"
}'

Whitelist IP

Aggiungi un ulteriore livello di sicurezza limitando l'accesso API a indirizzi IP specifici. Questo è opzionale ma consigliato per la produzione.

Configurare il Whitelist IP

  1. Vai a ImpostazioniSicurezza
  2. Abilita Whitelist IP
  3. Aggiungi gli indirizzi IP del tuo server
  4. Salva

Qualsiasi richiesta da un IP non whitelistato restituisce 403 Forbidden.

Codici di Errore

CodiceSignificatoAzione
401Credenziali non valideVerifica la API key o le credenziali di Autenticazione di Base
403IP non autorizzatoVerifica che il tuo IP sia whitelistato (se abilitato)

Best Practice di Sicurezza

  1. Non esporre mai le API key nel codice lato client — Usale solo sul tuo server backend
  2. Archivia le key nelle variabili d'ambiente — Non hardcoderl
  3. Rigenerare se compromessa — Vai a Impostazioni → API Keys e genera una nuova
  4. Usa HTTPS solamente — Tutte le richieste devono essere su HTTPS
  5. Ruota le credenziali periodicamente — Rigenerare le key ogni 90 giorni in ambienti ad alta sicurezza
  6. Registra l'accesso — Monitora l'utilizzo della tua API key nella dashboard

Esempio: Variabili d'Ambiente

Python:

import os
api_key = os.getenv('QLARA_API_KEY')

Node.js:

const apiKey = process.env.QLARA_API_KEY;

Bash:

curl -X POST https://lora-api.agiletelecom.com/api/message-server/sms/send \
-H "X-Api-Key: $QLARA_API_KEY" \
-d '...'

Hai bisogno di aiuto con l'autenticazione? Contatta il supporto all'indirizzo support@agiletelecom.com.