RCSZilla Versione 1.0

Autenticazione

Guida all'integrazione dell'app mobile

L'API usa l'autenticazione tramite token Bearer. Esistono due tipi di chiave API: una chiave API utente (nessun dispositivo Android necessario) e un token per dispositivo (legato a un telefono Android registrato).

Tipi di token

Scegli il tipo di token che corrisponde alla tua integrazione di marketing SMS gratuito:

Chiave API utente - per accesso diretto all'API (senza telefono)

Nessun dispositivo richiesto

Il modo più semplice per integrare. Genera una chiave API personale dalla pagina Impostazioni del pannello web e usala per mettere in coda SMS, messaggi WhatsApp e campagne tramite qualsiasi client HTTP.

  1. Accedi al pannello web e vai su Impostazioni.
  2. Scorri fino alla sezione Chiave API e clicca su Genera chiave.
  3. Copia la chiave e usala nell'header Authorization: Bearer delle tue richieste.
*
Puoi rigenerare la tua chiave in qualsiasi momento da Impostazioni > Chiave API. La vecchia chiave viene invalidata immediatamente.

Token per dispositivo - per l'app Android

Dispositivo Android richiesto

Ogni telefono Android registrato nella sezione Dispositivi riceve il proprio token. Questo token viene utilizzato dall'app Android per recuperare la coda di messaggi, segnalare lo stato di consegna e sincronizzare la posta in arrivo.

  1. Vai su Dispositivi > Aggiungi dispositivo nel pannello web.
  2. Scansiona il codice QR con l'app Android. L'app chiama claim_device e il token viene salvato automaticamente.
  3. L'app usa Authorization: Bearer {token} per tutte le richieste successive.

Invio del token

Header Authorization (preferito)

HTTP
Authorization: Bearer YOUR-API-KEY

Header X-API-Token

HTTP
X-API-Token: YOUR-API-KEY

Parametro ?token= (alternativa quando gli header vengono bloccati dai proxy)

URL
https://api.rcszilla.com/?endpoint=queue_sms&token=YOUR-API-KEY
*
I token vengono memorizzati e confrontati in maiuscolo. L'API normalizza automaticamente il tuo token.

Token legacy

Le versioni precedenti utilizzavano un singolo mobile_app_token condiviso per utente memorizzato nelle impostazioni. Questo funziona ancora per compatibilità, ma la chiave API utente o i token per dispositivo sono fortemente consigliati.

*
Nota di migrazione: Se la tua app è stata creata prima dell'aggiunta del supporto multi-dispositivo, potrebbe utilizzare il token legacy. Per migrare, apri la pagina Dispositivi nel pannello web, genera un token per dispositivo e aggiorna la configurazione dell'app.

Ciclo di vita del token dispositivo

  1. L'admin apre Dispositivi > Aggiungi dispositivo nel pannello web e viene generato un token di registrazione unico (codice QR).
  2. L'app scansiona il QR e chiama claim_device con quel token.
  3. Il server crea il record del dispositivo. Lo stesso token diventa ora il token API permanente per dispositivo.
  4. L'app memorizza il token in modo sicuro (EncryptedSharedPreferences Android consigliato).
  5. Tutte le richieste successive usano Authorization: Bearer {token}.
  6. L'admin può rigenerare il token in qualsiasi momento dalla pagina Dispositivi. Il vecchio token viene invalidato immediatamente.