Systemmails

immonex-ONE-Partner (Provider) haben die Möglichkeit, die sitebezogene E-Mail-Kommunikation mit ihren Kunden, bspw. die Übermittlung von Zugangsdaten, selbst umzusetzen. Alternativ können aber auch hierfür von der ONE API bereitgestellten Funktionen genutzt werden, worauf sich die Infos der folgenden Abschnitte beziehen.

Ist die eigene Mailverarbeitung eines Providers aktiviert, schlagen API-Anfragen mit den folgenden Endpunkten generell fehl.

Absender, Betreff und Inhalte der Systemmails können pro Provider individuell gestaltet werden: Neben Rahmentemplates (inkl. Signatur etc.) kann für jeden Mailtyp (optional) jeweils eine eigene Text- und HTML-Vorlage mit partnerspezifischem Branding hinterlegt werden.

Mail-Templates enthalten - je nach Typ - unterschiedliche Platzhalter, die durch Daten der jeweiligen ONE Site ersetzt werden, auf die sich die API-Anfrage bezieht.

Mail versenden

Endpunkt
GET https://api.immonex.one/wp-json/one-api/v2/sites/:id/mails/:type

Der Mailversand erfolgt beim Request und erfolgreicher Prüfung aller Parameter umgehend, es ist also aktuell keine Queue o. ä. zwischengeschaltet.

Der Parameter id ist die ID der ONE Site, woraus sich sowohl der Empfänger (Site-Inhaber) als auch die in die Mail einzufügenden Daten ergeben. Die Angabe type bezeichnet den Typ der zu versendenden Mail:

Anmeldebestätigung

Mit customer_signup_conf wird eine Bestätigung der Anmeldung bzw. Erstellung der ONE Site an den Inhaber (Immobilienmakler) gesendet. Diese enthält auch einen Link zur Bestätigung der Mailadresse.

Beispielinhalt (Standard-Plain-Text-Version ohne Signatur)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

Lisa, deine immonex ONE Website ist startklar!

Hallo Lisa,

herzlich willkommen bei immonex ONE!

Bitte bestätige noch kurz per Klick auf den folgenden Link, dass diese bei der
Anmeldung angegebene E-Mail-Adresse korrekt ist:

https://xyz-immo.immonex.one/?do=confirm_mail&t=12AB345C6

Deine neue Website ist bereits unter folgender Adresse erreichbar:

https://xyz-immo.immonex.one/

ACHTUNG! Wird die Anmeldung bzw. die Mailadresse nicht innerhalb von 48 Stunden
bestätigt, wird die neu angelegte Website zunächst deaktiviert und etwas
später automatisch gelöscht.

Falls du dich nicht selbst angemeldet haben solltest oder deine Mailadresse
versehentlich verwendet wurde, kannst du diese Nachricht einfach ignorieren.

Beste Grüße

Dein immonex ONE Team

Request (Beispiel)
GET https://api.immonex.one/wp-json/one-api/v2/sites/321/mails/customer_signup_conf

Response (Erfolg)
200 OK

Response (eigene Mailverarbeitung durch Partner/Provider)
403 Forbidden

1
2
3
4
5
6
7

{
    "code": "custom_mail_processing_only",
    "message": "",
    "data": {
        "status": 403
    }
}

Zugangsdaten

Mit einer Systemmail des Typs customer_credentials werden dem Endkunden alle nötigen URLs und Zugangsdaten übermittelt, die er für die Befüllung seiner ONE Site mit seinen eigenen Inhalten benötigt (Texte, Bilder, Import von Immobilienangeboten per OpenImmo-Schnittstelle).

Request (Beispiel)
GET https://api.immonex.one/wp-json/one-api/v2/sites/321/mails/customer_credentials

Beispielinhalt (Standard-Plain-Text-Version ohne Signatur)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

Lisa, fülle nun deine immonex ONE Website mit deinen eigenen Inhalten!

Hallo Lisa,

wenn du die redaktionellen Inhalte (Texte, Logo, Portraitfoto) deiner immonex
ONE Website bearbeiten möchten, melden Sie sich unter dieser Adresse...

https://xyz-immo.immonex.one/bearbeiten

...mit den folgenden Zugangsdaten an:

Benutzername: redaktion-XXXX
Kennwort: ***

Nach dem Einloggen findest du hier eine Übersicht der nächsten Schritte.

Alles Wissenswerte zur Nutzung deiner ONE Website sowie praxisnahe Leitfäden
haben wir für dich im "Handbuch" zusammengefasst:

https://docs.immonex.de/one-handbuch/

Deine aktuellen Immobilien-Angebote pflegst du wie gehabt in deiner
Immobilien-Verwaltungssoftware. Von hier aus werden diese dann per
OpenImmo-Export-Schnittstelle in deine immonex ONE Website übertragen.

Bitte hinterlege hierfür die passenden FTP-Zugangsdaten in den
entsprechenden Schnittstellen-Optionen deiner Software:

FTP-Host (Servername): import.immonex.one
Benutzername: ***
Kennwort: ***

Ordner/Pfad: /
Anbieternummer (optional): XXXX
Anzeigenkontingent (optional): 1000
Übertragungsformat: OpenImmo-XML (aktuellste Version)

Die vorhandenen Demo-Objekte werden übrigens mit der ersten regulären
Übertragung deiner Angebote automatisch gelöscht.

Du hast Fragen hierzu? Antworte einfach auf diese Mail oder besuche das
immonex ONE Helpdesk:

https://hilfe.immonex.one/

Wir wünschen dir viel Erfolg mit immonex ONE!

Beste Grüße

Dein immonex ONE Team

Response (Erfolg)
200 OK