...
JSON (HTTP POST, application/json) (
Beispiel Call getManufacturers):
Code Block | ||
---|---|---|
| ||
{ "function": "getManufacturers", "paras": { "user": "{{api_user}}", "pass": "{{api_password}}", "start": 0, "size": 50, "extNumberRange": 0 } } |
SOAP/XML (SOAP oder HTTP POST, text/xml)
Beispiel Call getManufacturers):
Code Block | ||||
---|---|---|---|---|
| ||||
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header/> <soapenv:Body> <getManufacturers soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <user xsi:type="xsd:string">{{api_user}}</user> <pass xsi:type="xsd:string">{{api_password}}</pass> <start xsi:type="xsd:int">0</start> <size xsi:type="xsd:int">50</size> <extNumberRange xsi:type="xsd:int">?</extNumberRange> </getManufacturers> </soapenv:Body> </soapenv:Envelope> |
...
Parameter | Type | |
---|---|---|
user | String | API Benutzername |
pass | String | API Passwort |
start | int | Start-Wert bei Block-Abfragen Beispiel: start 0 size 50 liefert die ersten 50 Einträge (gleichzusetzen mit SQL LIMIT 0,50) start 50 size 50 liefert Einträge 51-100 (LIMIT 50,100) |
size | int | Blockgröße |
Response
Bei fehlerhaften Zugangsdaten erfolgt ein Response mit HTTP Status 401
Code Block | ||
---|---|---|
| ||
{
"result": false,
"message": "LOGIN FAILED"
} |
Code Block | ||||
---|---|---|---|---|
| ||||
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="http://www.xt-commerce.com/services#xtconnect">
<SOAP-ENV:Body>
<ns1:getManufacturersResponse xmlns:ns1="http://schemas.xmlsoap.org/soap/envelope/">
<result xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:manufacturerListItem[0]"/>
<message xsi:type="xsd:string">LOGIN FAILED</message>
</ns1:getManufacturersResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> |