Api Keys

Einleitung

Im Menü „API Keys" können Sie einen sicheren und eindeutigen Schlüssel generieren.
Dieser dient zur Fernauslösung von Alarmen über Drittsysteme.

Je nach den von Ihnen gebuchten Modulen stehen Ihnen bis zu drei unterschiedliche Kommunikationsprotokolle zur Verfügung:

REST-Schnittstelle (optional)
Webin - eine HTTPS-basierte Standardschnittstelle
SOAP-Schnittstelle (optional)

REST‑Schnittstelle

Für die Implementierung steht Ihnen einer unserer Spezialisten zur Verfügung.

Webin- eine HTTPS-basierte Standardschnittstelle

Wenn Sie einem Drittsystem erlauben möchten, in Ihrem Konto einen Alarm auszulösen, müssen Sie dafür einen eindeutigen Schlüssel (API-Key) generieren und diesen anschließend in den entsprechenden HTTPS-Link einfügen.

Wichtig:
Der API-Key wird nur einmalig angezeigt, direkt nach der Erstellung.
Stellen Sie daher sicher, dass Sie den Schlüssel an einem sicheren Ort speichern.
Sollten Sie den Schlüssel verlieren, müssen Sie einen neuen API-Key generieren.

eAlarm emergency - URL-Syntax für die Auslösung

Die Auslösung erfolgt per Weblink (HTTPS ist zwingend) mit dem in der Vorlage hinterlegten Alarmtext.

Beispiel einer Alarmvorlage- Auslösung mit Standardtext


https://emergency.swisscom-alarm.ch/webin.php?apikey=key
&template=xxx
&text=0
&duration=8

Beispiel einer Alarmvorlage - Auslösung mit Freitext (Deutsch)


https://emergency.swisscom-alarm.ch/webin.php?apikey=key
&template=xxx
&dtfree=Guten Tag
&duration=8

Parameterbeschreibung

Parameter	Beschreibung
apikey	Der generierte API-Key ist eindeutig und 64 Zeichen lang.
template	Der Auslösecode entspricht dem numerischen Code der auszulösenden Alarmvorlage.
scenario	Der Auslösecode entspricht dem numerischen Code des auszulösenden Drehbuchs.
conference	Der Auslösecode entspricht dem numerischen Code der auszulösenden Konferenz.
event	Der Auslösecode entspricht dem alphanumerischen Code des auszulösenden Ereignisses.
text	Der Code des zu verwendenden Alarmtextes. Wenn der Parameter fehlt, wird ein Freitext gesendet. Steht der Code auf 0, wird der Standardtext versendet.
xxfree	Ein in der URL mitgegebener Freitext in entsprechender Sprache. Verfügbare Varianten: - dtfree für Deutsch - frfree für Französisch - itfree für Italienisch - enfree für Englisch
duration	Dauer (in Minuten), nach der der Alarm automatisch beendet wird. Wenn der Parameter fehlt, bleibt der Alarm offen, bis die globale Standarddauer erreicht ist oder der Alarm manuell terminiert wird.

Mehrsprachige Alarmierung

Über den Weblink kann mehrsprachig alarmiert werden, indem die verschiedenen xxfree Parameter hintereinander gesetzt werden:

&dtfree=Guten Tag&frfree=Bonjour&enfree=Good morning

Jeder Alarmteilnehmer erhält automatisch den Text in der für ihn definierten Sprache (falls vorhanden).
⚠️ Wenn der Parameter text vorhanden ist, werden die xxfree‑Parameter nicht ausgewertet.
QR-Code-Erstellung für die Alarmierung

Wenn Sie die oben gezeigte URL-Syntax in einen
➡️ QR-Code-Generator eingeben, können Sie einen QR-Code für die Auslösung erzeugen.

Praktischer Einsatz

Den erzeugten QR‑Code können Sie auf einer Notfall‑ oder Alarmtafel anbringen.
Durch einfaches Scannen mit dem Smartphone oder einem Endgerät wird der Alarm direkt ausgelöst.
Dieses Verfahren ermöglicht eine schnelle und effiziente Alarmierung, z. B. der Betriebssanität, des Notfallteams oder anderer vordefinierter Einsatzgruppen.
Rückmeldungen auf den Auslöse‑Weblink‑Request

Je nach im Registry‑Key “Language Remote Alerting” eingestellter Sprache gibt der Weblink folgende Antwortmeldungen zurück:

Typ / Auslöser	Deutsch (de)	Französisch (fr)	Italienisch (it)	Englisch (en)
Template (Vorlage)	OK: Alarm erfolgreich ausgelöst. Text: xxx Teilnehmer: 1 alarmiert. (AKEY-xxx)	OK : Alarme déclenchée avec succès. Texte : xxx Participants : 1 alerté. (AKEY-xxx)	OK: Allarme attivato con successo Testo: xxx Partecipanti: 1 allertato. (AKEY-xxx)	OK: Alert successfully triggered Text: xxx Participants: 1 alerted. (AKEY-xxx)
Drehbuch (Scenario)	OK: Drehbuch erfolgreich ausgelöst. (BKEY-xxx)	OK : Scénario déclenché avec succès. (BKEY-xxx)	OK: Scenario attivato con successo. (BKEY-xxx)	OK: Scenario successfully triggered. (BKEY-xxx)
Konferenz	OK: Konferenz erfolgreich ausgelöst. (CKEY-xxx)	OK : Conférence déclenchée avec succès. CKEY-xxx)	OK: Conferenza attivata con successo. CKEY-xxx)	OK: Conference successfully triggered. CKEY-xxx)
Ereignis	Event Trigger processed: OK: Alarm ‘xxx’ erfolgreich ausgelöst. Text: xxx Teilnehmer: 1 alarmiert. (AKEY-xxx)	Event Trigger processed: OK: Alarme déclenchée avec succès à ‘xxx’. Texte: xxx participant(s): 5 alarmé(s). (AKEY-xxx)	Event Trigger processed: OK: Allarme ‘xxx’ lanciato con successo. Testo: xxx Utenti: 1 Allarmato. (AKEY-xxx)	Event Trigger processed: OK: Alert ‘xxx’ successfully triggered. Text: xxx Subscriber: 1 alerted. (AKEY-xxx)
Template / Drehbuch / Konferenz fehlerhaft	Not_OK: Alarmvorlage, Konferenzvorlage oder Drehbuch nicht gefunden.	Not_OK : Modèle d’alarme, conférence ou scénario introuvable.	Not_OK: Modello d’allarme, conferenza o scenario non trovato.	Not_OK: Alarm template, conference or scenario not found.
Ereignis fehlerhaft	Not_OK: Event nicht gefunden	Not_OK: Evénement non trouvé	Not_OK: Evento non trovato	Not_OK: Event not found
Ping‑Rückmeldung	OK: Ping‑Ereignis verarbeitet.	OK : Événement de ping traité.	OK: Evento di ping elaborato.	OK: Ping event processed.
Fehlerhafte Zugangsdaten	Not_OK: Falsche oder nicht existierende Anmeldedaten oder IP‑Adresse gesperrt.	Not_OK : Données d’identification erronées ou adresse IP bloquée.	Not_OK: Credenziali errate o indirizzo IP bloccato.	Not_OK: Invalid credentials or IP address blocked.

Technischer Hinweis

Die Sprache der Rückmeldungen richtet sich nach dem Registry‑Eintrag:
HKEY_LOCAL_MACHINE\SOFTWARE\Swisscom\eAlarm\Language Remote Alerting
Zulässige Werte sind: de, fr, it, en.
Wenn der Eintrag fehlt oder falsch gesetzt ist, wird Englisch verwendet.

SOAP‑Schnittstelle

Die Einrichtung einer Verbindung des Drittsystems über SOAP erfolgt mit Unterstützung eines unserer Spezialisten.