anthrazit – Schnittstellen

XML Schnittstelle : 4 Commands für Schnittstelle

Mon. 26. June 2023 16:35 Uhr

WICHTIGER HINWEIS

Diese hier auf Seite beschriebenen Commands werden ab Oktober 2023 nicht mehr unterstützt.
Verwendien Sie stattdessen diese unter 5. berschriebenen API Requets


4.1 Schreiben/updaten von Datensatz/-sätzen mit GET

   
GET URL https://benutzername:passwort@xml.mopage.ch/infoservice/xml.php?url=URL_TO_XML_FILE
Parameter url: URL codierte Webadresse zur XML Datei
Beschreibung Der Partner macht einen GET Request auf die Schnittstelle, übergibt ihr via GET Parameter url eine Webadresse auf den XML Datei, welche die zu importierenden Datensätze enthält. Die moPage-Schnittstelle wiederum ruft die erhaltene Adresse auf, parst den XML Feed und importiert/updatet die Datensätze in die eigene Datenbank.
Anmerkung Erwartete XML Datenstruktur wird unter Punkt 4. beschrieben.
Im XML File können 1 oder mehrere 'Datensätze' angeliefert werden. Wird nur 1 angeliefert, heisst dies NICHT, dass alle anderen, die bei einem früheren Import schon erfasst wurden, gelöscht werden. Löschen eines Datensatzes ist ein separater Aufruf (s. unten).

4.2 Schreiben/updaten von Datensatz/-sätzen mit POST

   
POST URL https://benutzername:passwort@xml.mopage.ch/infoservice/xml.php
Beschreibung XML Daten müssen im Body des HTTP POSTs stehen. Genaue Struktur des XMLs entnehmen Sie den Punkten 2 und 3.

4.3 Liste importierter Datensätze anfordern

   
Aufruf https://benutzername:passwort@xml.mopage.ch/infoservice/xml.php?do=getlist&partnerid=111&pwd=xyzabc&importid=1
Parameter  partnerid: Ihre Partner ID (in separaten Dokument)
pwd: Ihr Passwort (in separaten Dokument)
importid: wenn gesetzt, werden nur Datensätze dieses Imports geliefert.
do: getlist eigentliches Kommando
id: ID des zu löschenden Datensatzes

Als Resultat erhalten Sie ein XML in folgender Form:

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<list>
    <item status="1" suchbar="1" datumvon="" datumbis="" geloescht="0">
        <id>01</id>
        <objektkey>123456789</objektkey>
        <titel>Datensatztitel</titel>
    </item>
    <item status="1" suchbar="1" datumvon="" datumbis="" geloescht="0">
        <id>03</id>
        <objektkey>112233</objektkey>
        <titel>Anderer Titel</titel>
    </item>
</list>

4.4 Löschen von einzelnen Datensätzen

   
Aufruf https://benutzername:passwort@xml.mopage.ch/infoservice/xml.php?partnerid=111&pwd=xyzabc&importid=1&do=delete&id=123
Parameter partnerid: Ihre Partner ID (in separaten Dokument)
pwd: Ihr Passwort (in separaten Dokument)
importid: wenn gesetzt, werden nur Datensätze dieses Imports geliefert.
do: delete eigentliches Kommando
id: ID des zu löschenden Datensatzes