Online-Documentation Weblication® SEND
INFO: Version .x

Weblication® SEND - REST API

In aktueller Version von Weblication® SEND steht Ihnen eine REST API zur Verfügung.

Aktuell werden folgende Funktionen unterstützt:

  • Anmeldung
  • Nachrichtenversand
  • Nachrichten-Abruf

Zur einfachen Implementierung steht das PHP sendMessenger-Plugin zur Verfügung, das ein Messenger-Objekt erzeugt. Das Messenger Plugin demonstriert die Nutzung der REST-API und vereinfacht diese. Das Messenger Plugin erhalten Sie auf Anfrage über den Support (Support-Formular). In absehbarer Zeit wird dies auch zum Download angeboten werden.

Beispiel: Nutzung des Messenger

// --------- Messenger

$apidata = [
  
'host' => 'https://send.domain.dd',
  
'apiKey' => 'key',
  
'apiPassphrase' => 'passphrase',
];
$messenger = new \sendMessenger\messenger$apidata );

Beispiel: Nutzung zum Nachrichtenversand

// --------- Nachricht versenden

$data = [
  
'from' => 'sender@domain.dd',
  
'to' => 'receiver@domain.dd',
  
'subject' => 'Betreff',
  
'message' => 'Unverschlüsselte Nachricht',
  
'messageSecure' => 'verschlüsslte Nachricht'
];

$fileData = [
  
'path' => '/path/to/file'
];

$messenger->send$data$fileData );

Beispiel: Nutzung der Nachrichtenübersicht für einen Empfänger

// --------- Nachrichtenübersicht abrufen - von einem Empfänger

$postData = [
  
'username' => 'user'// Benutzername des Empfängers
  
'userpass' => 'pass'// Passwort des Empfängers
];

$headers $messenger->fetchHeaders$postData );

Beispiel: Nutzung zum Nachrichtenabruf über Id

// --------- Nachricht mit Id abrufen
$messenger->setDownloadDirFiles'/download' ); // Setzt das
Zielverzeichnis für ggfs in der Nachricht enthaltene Dateien

$fetchedData 
$messenger->fetch(
  
$postData = [
    
'username' => 'user'// Benutzername des Empfängers
    
'userpass' => 'pass'// Passwort des Empfängers
    
'messageId' => ''// Message Id der Nachricht
  
]
);

Powered by Weblication® CMS