Autentificare

Ghid de integrare aplicație mobilă

API-ul folosește autentificarea prin token Bearer. Există două tipuri de cheie API: o cheie API de utilizator (fără dispozitiv Android necesar) și un token per dispozitiv (legat de un telefon Android înregistrat).

Tipuri de token

Alegeți tipul de token care se potrivește integrării dvs. de marketing SMS gratuit:

Cheie API utilizator - pentru acces direct la API (fără telefon)

Nu este necesar un dispozitiv

Cel mai simplu mod de integrare. Generați o cheie API personală din pagina Setări a panoului web și folosiți-o pentru a pune în coadă SMS-uri, mesaje WhatsApp și campanii prin orice client HTTP. Nu este necesar un dispozitiv Android sau o cartelă SIM când mesajele sunt trimise prin furnizori SMS conectați sau credite.

Autentificați-vă în panoul web și mergeți la Setări.
Derulați până la secțiunea Cheie API și faceți clic pe Generați cheie.
Copiați cheia și folosiți-o în antetul Authorization: Bearer al cererilor dvs.

Puteți regenera cheia oricând din Setări > Cheie API. Cheia veche este invalidată imediat, actualizați toate integrările înainte de regenerare.

Token per dispozitiv - pentru aplicația Android

Necesită dispozitiv Android

Fiecare telefon Android înregistrat în secțiunea Dispozitive primește propriul token. Acesta este folosit de aplicația Android pentru a prelua coada de mesaje, a raporta starea livrării și a sincroniza inbox-ul.

Mergeți la Dispozitive > Adăugați dispozitiv în panoul web.
Scanați codul QR cu aplicația Android. Aplicația apelează claim_device și tokenul este stocat automat.
Aplicația folosește Authorization: Bearer {token} pentru toate cererile ulterioare.

Trimiterea tokenului

Antet Authorization (recomandat)

HTTP

Authorization: Bearer YOUR-API-KEY

Antet X-API-Token

HTTP

X-API-Token: YOUR-API-KEY

Parametru interogare ?token= (alternativă când antetele sunt blocate de proxy)

URL

https://api.rcszilla.com/?endpoint=queue_sms&token=YOUR-API-KEY

Tokenurile sunt stocate și comparate cu majuscule. API-ul normalizează automat tokenul dvs.

Token moștenit

Versiunile mai vechi foloseau un singur mobile_app_token per utilizator stocat în setări. Acesta funcționează în continuare pentru compatibilitate inversă, dar Cheia API de utilizator sau tokenurile per dispozitiv sunt puternic recomandate.

Notă migrare: Dacă aplicația dvs. a fost construită înainte de adăugarea suportului multi-dispozitiv, poate folosi tokenul unic moștenit. Pentru migrare, deschideți pagina Dispozitive în panoul web, generați un token per dispozitiv și actualizați configurația aplicației.

Ciclul de viață al tokenului de dispozitiv

Administratorul deschide Dispozitive > Adăugați dispozitiv în panoul web și se generează un token de înregistrare unic (cod QR).
Aplicația scanează QR-ul și apelează claim_device cu acel token.
Serverul creează înregistrarea dispozitivului. Același token devine acum token API permanent per dispozitiv.
Aplicația stochează tokenul în siguranță (se recomandă EncryptedSharedPreferences Android).
Toate cererile ulterioare folosesc Authorization: Bearer {token}.
Administratorul poate regenera tokenul oricând din pagina Dispozitive. Tokenul vechi este invalidat imediat.