API Key generieren

Für die Verwendung der BerlinSMS API für Versand, Empfang und Statistik brauchen Sie einen API-Key. Dieser Schlüssel ist Ihr sicherer Zugang zur API. Sorgen Sie dafür, dass dieser nicht in falsche Hände gerät. Mit einem gestohlenen API-Key könnten auf Ihre Kosten z.B. SMS versandt werden..

Sie können diesen APIkey nicht im Frontend verwenden, da er dort frei zugänglich wäre. Dadurch ist es erforderlich, dass Sie den Versand stets aus einer sicheren Umgebung, z.B.Backend durchführen.

Bitte beachten Sie die folgenden Schritte, um den API-Key zu erhalten:

  1. Registrieren Sie sich oder melden Sie sich an: https://app.berlinsms.de/
  2. Navigieren Sie über die Sidebar auf die Seite „Mein Profil“ oder über folgenden Link: https://app.berlinsms.de/profile
  3. Sollte bereits ein Eintrag existieren, so sehen Sie das Datum der letzten Erzeugung und daneben den Button „API-Key deaktivieren“. Beachten Sie, dass damit alle Software, die den bisherigen Key. Sie können einen neuen API-Key generieren. Bitte beachten Sie, dass dadurch alle vorherigen API-Key
  4. Existiert noch kein Eintrag, klicken Sie auf „API-Key generieren“ und setzen bei Punkt 5 fort.
    Sollte bereits ein Eintrag existieren, so sehen Sie das Datum der letzten Erzeugung und daneben den Button „API-Key deaktivieren“. Das Deaktiveren dieses API-Keys würde dazu führen, dass jegliche Software, die diesen Key verwendet keinen Zugriff mehr erhält und nach einer Anzahl von Versuchen unter Spam-Verdacht steht. Vergewissern Sie sich also sorgfältig, bevor Sie einen Key deaktivieren. Nach dem Deaktivieren können Sie wie oben beschrieben einen neuen Key erzeugen.
  5. Ihnen wird nun ein API-Key angezeigt. Bewaren Sie diesen Key sorgfältig aus, er wird Ihnen später nicht mehr angezeigt. Wir empfehlen, den Key in einem Passwortmanager zu speichern und zeitnah in die Konfiguration Ihrer Software zu übernehmen. Sollte Ihnen der Key abhanden kommen, gibt es keine Wiedeherstellungsmöglichekeit. Es bleibt Ihnen nur noch der in Punkt 4 beschriebene Weg über „API-Key deaktivieren“
  6. Sollten Sie Konten verwenden, so können Sie für jedes einzelne Konto einen eigenen API-Key erzeugen. Gehen Sie dazu über die Sidebar auf die Seite „Kontenverwaltung“ oder über folgenden Link: https://app.berlinsms.de/account-manager
    Hinweis: Diese Seite steht Ihnen nur zur Verfügung, wenn Ihr Account dafür freigeschaltet wurde. Sprechen Sie unseren Support an, falls Sie die Kontenverwaltung benötigen
  7. Expandieren Sie ein Konto und klicken Sie auf „API-Key generieren“.
  8. Wie in Punkt 4 und 5 beschrieben, werden auch die API-Keys Ihrer Konten nur einmalig angezeigt, können aber deaktiviert und neu erzeugt werden.

Mit Hilfe der API-Keys können Sie mit der Implementierung auf Ihrer eigenen Webseite fortfahren.

Tutorials