RCSZilla Version 1.0

Authentifizierung

Integrationsleitfaden für mobile App

Die API verwendet Bearer-Token-Authentifizierung. Es gibt zwei Arten von API-Schlüsseln: einen Benutzer-API-Schlüssel (kein Android-Gerät erforderlich) und ein Geräte-Token (an ein registriertes Android-Telefon gebunden).

Token-Typen

Wählen Sie den Token-Typ, der Ihrer kostenlosen SMS-Marketing-Integration entspricht:

Benutzer-API-Schlüssel - für direkten API-Zugriff (kein Telefon erforderlich)

Kein Gerät erforderlich

Die einfachste Integrationsmethode. Generieren Sie einen persönlichen API-Schlüssel auf der Einstellungsseite des Web-Panels und verwenden Sie ihn, um SMS, WhatsApp-Nachrichten und Kampagnen über einen beliebigen HTTP-Client in die Warteschlange zu stellen.

  1. Melden Sie sich im Web-Panel an und gehen Sie zu Einstellungen.
  2. Scrollen Sie zum Abschnitt API-Schlüssel und klicken Sie auf Schlüssel generieren.
  3. Kopieren Sie den Schlüssel und verwenden Sie ihn im Authorization: Bearer-Header Ihrer Anfragen.
*
Sie können Ihren Schlüssel jederzeit unter Einstellungen > API-Schlüssel neu generieren. Der alte Schlüssel wird sofort ungültig.

Geräte-Token - für die Android-App

Android-Gerät erforderlich

Jedes in der Geräte-Sektion registrierte Android-Telefon erhält sein eigenes Token. Dieses Token wird von der Android-App verwendet, um die Nachrichtenwarteschlange abzurufen, den Lieferstatus zu melden und den Posteingang zu synchronisieren.

  1. Gehen Sie im Web-Panel zu Geräte > Gerät hinzufügen.
  2. Scannen Sie den QR-Code mit der Android-App. Die App ruft claim_device auf und das Token wird automatisch gespeichert.
  3. Die App verwendet Authorization: Bearer {token} für alle nachfolgenden Anfragen.

Token senden

Authorization-Header (empfohlen)

HTTP
Authorization: Bearer YOUR-API-KEY

X-API-Token-Header

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

Abfrageparameter ?token= (Fallback wenn Header von Proxies blockiert werden)

URL
https://api.rcszilla.com/?endpoint=queue_sms&token=YOUR-API-KEY
*
Token werden in Großbuchstaben gespeichert und verglichen. Die API normalisiert Ihr Token automatisch.

Legacy-Token

Ältere Versionen verwendeten ein einzelnes gemeinsames mobile_app_token pro Benutzer in den Einstellungen. Dies funktioniert noch für Abwärtskompatibilität, aber Benutzer-API-Schlüssel oder Geräte-Token werden dringend empfohlen.

*
Migrationshinweis: Wenn Ihre App vor der Unterstützung mehrerer Geräte erstellt wurde, verwendet sie möglicherweise das Legacy-Token. Öffnen Sie zum Migrieren die Seite Geräte im Web-Panel, generieren Sie ein Geräte-Token und aktualisieren Sie die App-Konfiguration.

Lebenszyklus des Geräte-Tokens

  1. Admin öffnet Geräte > Gerät hinzufügen im Web-Panel und ein Einmalregistrierungstoken (QR-Code) wird generiert.
  2. App scannt den QR und ruft claim_device mit diesem Token auf.
  3. Server erstellt den Gerätedatensatz. Dasselbe Token wird jetzt zum permanenten Geräte-API-Token.
  4. App speichert das Token sicher (EncryptedSharedPreferences für Android empfohlen).
  5. Alle nachfolgenden Anfragen verwenden Authorization: Bearer {token}.
  6. Admin kann das Token jederzeit von der Geräteseite neu generieren. Das alte Token wird sofort ungültig.