Allgemein

Der BOSNotifier bietet eine API an, mit der Sie Nachrichten an Ihre Organisation versenden können. Das folgende Kapitel beschreibt den generellen Aufruf der API.

API Endpoints

https://api.bosnotifier.de

API Aufruf

Nachrichten versenden

API Funktion: /messages

Request Typ: POST

Authentifizierung: Bearer Token im Header

Payload Typ: JSON

Erfolgsmeldung: HTTP Statuscode 201

API Parameter:

  • group (erforderlich) ==> Gruppenschlüssel zur Adressierung der richtigen Empfängergruppe
  • title (erforderlich) ==> Überschrift einer Nachricht in der App
  • text (erforderlich) ==> Inhalt einer Nachricht in der App
  • street (optional) ==> Strasse zur Bestimmung des Orts einer Nachricht
  • houseNo (optional) ==> Hausnummer zur Bestimmung des Orts einer Nachricht
  • zipCode (optional) ==> Postleitzahl zur Bestimmung des Orts einer Nachricht
  • town (optional) ==> Ort zur Bestimmung des Orts einer Nachricht
  • country (optional) ==> Land zur Bestimmung des Orts einer Nachricht

Beispiele

Powershell

## Parameter
$apiKey = "xxxxx"
$group = "yyyyy"
$title = "Test"
$text = "Test"
$street = ""
$houseNo = ""
$zipCode = ""
$town = ""
$country = ""

## Aufruf
$url = "https://api.bosnotifier.de/messages"
$body = @{
            "group"="$group";
            "title"="$title";
            "text"="$text";
            "street"="$street";
            "houseNo"="$houseNo";
            "zipCode"="$zipCode";
            "town"="$town";
            "country"="$country";
         }

## Nur TLSv1.1 und TLSv1.2 zulassen
$AllProtocols = [System.Net.SecurityProtocolType]'Tls11,Tls12'
[System.Net.ServicePointManager]::SecurityProtocol = $AllProtocols

$headers = @{"Authorization" = "Bearer " + $apiKey}
$result = Invoke-RestMethod -Uri $url -Headers $headers -Body $body -Method Post

PHP

## Parameter
$apiKey = "xxxxx";
$group = "yyyyy";
$title = "Test";
$text = "Test";
$street = "";
$houseNo = "";
$zipCode = "";
$town = "";
$country = "";

## Aufruf
$data = array("group" => $group, "title" => $title, "text" => $text, "street" => $street, "houseNo" => $houseNo, "zipCode" => $zipCode, "town" => $town, "country" => $country);
$data_string = json_encode($data);

$ch = curl_init("https://api.bosnotifier.de/messages");                                                                      
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");                                                                     
curl_setopt($ch, CURLOPT_POSTFIELDS, $data_string);                                                                  
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);   
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); # Achtung! Dieser Aufruf verhindert die SSL Zertifikatsprüfung und sollte auf produktiven Installation auf true stehen                                                                 
curl_setopt($ch, CURLOPT_HTTPHEADER, array(                                                                          
    'Content-Type: application/json',                                                                
    'Content-Length: ' . strlen($data_string),
    'Authorization: Bearer '.$apiKey)                                                        
);                                                                                                                   

$result = curl_exec($ch);
#print curl_error($ch);
$httpcode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo "Response: ".$result."<br/>";
echo "HTTP Status: ".$httpcode;

Linux

curl -X POST -H "accept: application/json" -H "Authorization: Bearer XXXXXXXXXXXX" -H "Content-Type: application/json" -d '{ "group": "YYYYYYYYYY", "text": "Testalarm", "title": "Test", "street": "Musterstraße", "houseNo": "1", "zipCode": "12345", "town": "Musterhausen", "country": "Germany" }' https://api.bosnotifier.de/messages

Weiterführende Informationen

Weiterführende Informationen zu allen API Aufrufen können unter folgendem Link eingesehen werden: Swagger Definition.