Authentification

Guide d'intégration application mobile

L'API utilise l'authentification par token Bearer. Il existe deux types de clé API : une clé API utilisateur (sans appareil Android) et un token par appareil (lié à un téléphone Android enregistré).

Types de token

Choisissez le type de token correspondant à votre intégration de marketing SMS gratuit :

Clé API utilisateur - accès direct à l'API (sans téléphone)

Aucun appareil requis

La façon la plus simple d'intégrer. Générez une clé API personnelle depuis la page Paramètres du panneau web et utilisez-la pour mettre en file d'attente des SMS, messages WhatsApp et campagnes via n'importe quel client HTTP.

  1. Connectez-vous au panneau web et allez dans Paramètres.
  2. Faites défiler jusqu'à la section Clé API et cliquez sur Générer une clé.
  3. Copiez la clé et utilisez-la dans l'en-tête Authorization: Bearer de vos requêtes.
*
Vous pouvez régénérer votre clé à tout moment depuis Paramètres > Clé API. L'ancienne clé est immédiatement invalidée.

Token par appareil - pour l'application Android

Appareil Android requis

Chaque téléphone Android enregistré dans la section Appareils reçoit son propre token. Ce token est utilisé par l'application Android pour récupérer la file de messages, signaler le statut de livraison et synchroniser la boîte de réception.

  1. Allez dans Appareils > Ajouter un appareil dans le panneau web.
  2. Scannez le code QR avec l'application Android. L'application appelle claim_device et le token est stocké automatiquement.
  3. L'application utilise Authorization: Bearer {token} pour toutes les requêtes suivantes.

Envoi du token

En-tête Authorization (recommandé)

HTTP
Authorization: Bearer YOUR-API-KEY

En-tête X-API-Token

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

Paramètre ?token= (alternative quand les en-têtes sont bloqués par des proxies)

URL
https://api.rcszilla.com/?endpoint=queue_sms&token=YOUR-API-KEY
*
Les tokens sont stockés et comparés en majuscules. L'API normalise automatiquement votre token.

Token hérité

Les anciennes versions utilisaient un seul mobile_app_token par utilisateur stocké dans les paramètres. Cela fonctionne toujours pour la compatibilité ascendante, mais la clé API utilisateur ou les tokens par appareil sont fortement recommandés.

*
Note de migration: Si votre application a été construite avant l'ajout du support multi-appareils, elle utilise peut-être le token unique hérité. Pour migrer, ouvrez la page Appareils dans le panneau web, générez un token par appareil et mettez à jour la configuration de l'application.

Cycle de vie du token d'appareil

  1. L'admin ouvre Appareils > Ajouter un appareil dans le panneau web et un token d'enregistrement unique (code QR) est généré.
  2. L'app scanne le QR et appelle claim_device avec ce token.
  3. Le serveur crée l'entrée de l'appareil. Le même token devient maintenant le token API permanent par appareil.
  4. L'app stocke le token en sécurité (EncryptedSharedPreferences Android recommandé).
  5. Toutes les requêtes suivantes utilisent Authorization: Bearer {token}.
  6. L'admin peut régénérer le token à tout moment depuis la page Appareils. L'ancien token est immédiatement invalidé.