Pivacom Schnittstelle

Dies ist eine Schnittstelle zum Erstellen, Abfragen und Bearbeiten von Leads auf der Lead Handels Plattform von PIVASOFT Gmbh.


Interface Passwort erstellen

Wenn du dich als Broker angemeldet hast, (siehe Zugriff auf Brokeraccount) klicke auf Leadzulieferung > XMLRPC Schnittstelle in der Navigationsleiste. Klicke Passwort generieren am Ende der Seite. Dadurch wird die Schnittstelle freigeschalten und ein neues Passwort dafür generiert, welches als Schnittstellenpasswort angezeigt wird.

Mit Passwort neu generieren kann ein neues Passwort erstellt werden.

Mit Schnittstelle deaktivieren kann man das Passwort löschen und die Schnittstelle deaktivieren.

Lead-Felder einsehen

Wenn du dich als Broker angemeldet hast, (siehe Zugriff auf Brokeraccount) klicke auf Leadzulieferung > E-Mail-Schnittstelle in der Navigationsleiste.
Hier findest du sämtliche Felder zur Einlieferung von Leads. Am Ende der Seite können die spezifischen Felder für die dir freigegebenen Sparten eingesehen werden.

Anfragen machen

Um eine Anfrage zu machen, wird die Broker ID (einsehbar auf https://lhp.pivacom.com unter Account > Daten Ändern > Ihre BrokerCode) und das Interface Password (siehe Interface Passwort erstellen) benötigt.

Damit kann man sich dann für eine XMLRPC Anfrage an https://lhp.pivacom.com/interface/XMLRPC_Broker.php authorisieren.

Für die HTTP Anfrage muss der Header Content-Type:text/xml gesetzt sein.

Der Body der XMLRPC Anfrage muss folgendermaßen strukturiert sein:

<?xml version="1.0" encoding="iso-8859-1"?>
<methodCall>
    <methodName><!-- Füge hier den Methodennamen ein --></methodName>
    <params>
        <param>
            <value>
                <struct>
                    <member>
                        <name>InterfacePassword</name>
                        <value><string>Dein Interface Passwort</string></value>
                    </member>
                    <!-- Hier können weitere Felder als <member> Elemente eingefügt werden -->
                </struct>
            </value>
        </param>
    </params>
</methodCall>

Der Body muss als ISO8859-1 enkodiert sein.

Es können natürlich auch einfach, wie im folgenden PHP Beispiel, XMLRPC Bibliotheken genutzt werden:

$Request = xmlrpc_encode_request ('Lead.GetList', array(
    'InterfacePassword'=>'Dein Interface Passwort',
    'Page'=>'0'
));

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://lhp.pivacom.com/interface/XMLRPC_Broker.php');
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type:text/xml'));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_POSTFIELDS, $Request);

$Result = curl_exec($ch);
if($nr = curl_errno($ch)) {
    curl_error($ch);
}
curl_close($ch);

$AntwortArray = xmlrpc_decode($Result);

/*
  In $AntwortArray finden Sie die Leaddaten.
  Sie sind im UTF8 Zeichensatz gespeichert.
    
  Wenn die curl_* Funktionen nicht vorhanden sind müssen
  Sie zuerst CURL aktivieren. Lesen sie hierzu das PHP Handbuch.
  Gleiches gilt für die XMLRPC Funktionen.
*/  

Methoden

Die verfügbaren Methoden sind:

Methoden Name Parameter Beschreibung
Lead.GetList AbEingestellt: Einstelldatum ab dem die Leads angezeigt werden sollen. Das Format ist YYYY-MM-DD. Mit dieser Methode können Sie eine eine Liste Ihrer Leads erhalten. Sie bekommen maximal 200 Leads pro Aufruf. Sie können die nächsten Leads abfragen indem Sie den ‘page’ Parameter inkrementieren.
AbStart: Startdatum ab dem die Leads angezeigt werden sollen. Das Format ist YYYY-MM-DD.
Page: Ganze Zahl. Jeder Aufruf gibt maximal 200 Leads zurück. Wenn Sie page=0 einstellen erhalten Sie die ersten 200 Leads (also Leads 1 bis 200). Wenn sie page=1 einstellen die nächsten 200 (also Leads 201 bis 400). Usw.
Lead.GetListReklamiert AbEingestellt: Einstelldatum ab dem die Leads angezeigt werden sollen. Das Format ist YYYY-MM-DD. Mit dieser Methode erhalten Sie eine Liste Ihrer reklamierten Leads. Sie bekommen maximal 200 Leads pro Aufruf. Sie können die nächsten Leads abfragen indem Sie den ‘page’ Parameter inkrementieren.
AbStart: Startdatum ab dem die Leads angezeigt werden sollen. Das Format ist YYYY-MM-DD.
AbErstellt: Erstellungsdatum der Reklamation ab dem die Leads angezeigt werden sollen. Gilt für die aktuelle Reklamationsstufe. Das Format ist YYYY-MM-DD.
AbBearbeitet: Bearbeitungsdatum der Reklamation ab dem die Leads angezeigt werden sollen. Gilt für die aktuelle Reklamationsstufe.
Page: Ganze Zahl. Jeder Aufruf gibt maximal 200 Leads zurück. Wenn Sie page=0 einstellen erhalten Sie die ersten 200 Leads (also Leads 1 bis 200). Wenn sie page=1 einstellen die nächsten 200 (also Leads 201 bis 400). Usw.
Lead.GetDetails LeadId: Pflicht - Die Lead Id für den Lead dessen Details angezeigt werden sollen. Mit dieser Methode erhalten Sie alle Details, inklusive der Reklamationsdaten, eines Leads.
Lead.GetGeneralFiles LeadId: Pflicht - Die Lead Id für den Lead dessen Details angezeigt werden sollen. Mit dieser Methode erhalten Sie den Dateiinhalt in Base64 kodierung herunterladen. Die fileid erhalten Sie durch Lead.GetDetails.
FileId: Pflicht - Die File Id für die Datei deren Daten sie holen möchten.
Lead.GetReklaFiles LeadId: Pflicht - Die Lead Id für den Lead dessen Details angezeigt werden sollen. Mit dieser Methode erhalten Sie den Dateiinhalt in Base64 kodierung herunterladen. Die fileid erhalten Sie durch Lead.GetDetails.
FileId: Pflicht - Die File Id für die Datei deren Daten sie holen möchten.
Lead.Import Als Parameter müssen alle Felder übergeben werden die auch in der E-Mail-Schnittstelle übergeben werden müssen. Diese finden Sie unter Leadzulieferung > Schnittstelle. Mit dieser Methode können Sie Leads ins System einliefern.
Lead.SetAktiv LeadId: Pflicht - Die Lead Id für den Lead dessen Details angezeigt werden sollen. Mit diesen Methoden können Sie den Status eines Leads ändern.
Lead.SetInaktiv LeadId: Pflicht - Die Lead Id für den Lead dessen Details angezeigt werden sollen. Mit diesen Methoden können Sie den Status eines Leads ändern.
Lead.SetNichtGebucht LeadId: Pflicht - Die Lead Id für den Lead dessen Details angezeigt werden sollen. Mit diesen Methoden können Sie den Status eines Leads ändern.
Lead.SetUnbrauchbar LeadId: Pflicht - Die Lead Id für den Lead dessen Details angezeigt werden sollen. Mit diesen Methoden können Sie den Status eines Leads ändern.
Lead.SetDoppelt LeadId: Pflicht - Die Lead Id für den Lead dessen Details angezeigt werden sollen. Mit diesen Methoden können Sie den Status eines Leads ändern.