Promail REST API 2.0 ist ein einfacher Wege um Daten mit der Promail Plattform auszutauschen und zu bearbeiten.
Mit dem ArticleNew-API können neue Artikel an Promail übermittelt werden.
Basis HTTP
Das API ist HTTP-basiert. Das heisst das API kann mit HTTP Bibliotheken wie cURL oder urllib genutzt werden.
Dadurch kann das API direkt im Browser genutzt werden.
Host url
Anfragen können an die url https://test.deal1.ch/PromailRESTnew_skuV1.php geschickt werden.
Json
Die Abfragen sind in der JavaScript Sprache "Json" an das API zu schicken.
Beispiele unten.
POST
Das API reagiert auf die API Send-Methoden und steuert unterschiedliche Funktionen an.
Die Methode POST wird verwendet um Daten wie "neue Artikel" an Promail zu übermitteln.
Zugriffsschlüssel und API_Name
Um das API verwenden zu können, müssen die korrekten Zugriffsschlüssel und der gewünschte API-Name im API-Aufruf enthalten sein.
Das API verwendet 3 Schlüssel, welche beim API-Aufruf übergeben werden.
"Key" = x6R38e94z721GtUp (der Key steht in Bezug zu ihrem Promail-Konto).
"PrivatKey" = Muss bei Promail beantragt werden.
"Your_Email" = Die Emailadresse ihres Hauptkontos. Promail erteilt ihnen gerne Auskunft.
Mit "API-Name" wird die entsprechende Schittstelle ausgewählt. Partner/Kunden erhalten die Zugriffsschlüssel durch Anfrage-Mail an office@promail-ag.ch.
POST New Article übermitteln
Im folgenden PHP-Beispiel-Code werden 2 Artikel mit cURL übermittelt:
Erklärungen
Der Beispielcode übermittelt zwei Datensätze für zwei Artikel.
Auf diese Art können bis zu 50 Datensätze übermittelt werden.
key
bei Promail beantragen
mandatory
privatkey
bei Promail beantragen
mandatory
your_email
bei Promail beantragen
mandatory
api_name
mit "new_sku" wird das API angesteuert, welches neue Artikel ins Promail-WMS übermittelt
mandatory
sku
Artikelnummer
mandatory
name
Name des Artikels
mandatory
specification
Farbe / Grösse
discription
Beschreibung des Artikels
sku_barcode
Barcode des Artikels
mandatory
box_barcode
Barcode auf der Umverpackung
weight
Gewicht des Artikels in Gramm
mandatory
itemperbox
Stück pro Umverpackung
image
url zu einem Bild des Artikels
group
Gruppen-Namen, falls der Artikel zu einer Gruppe gehört
addsku
Wen zu diesem Artikel ein weiterer Artikel dazugepackt werden soll, muss hier die Artikelnummer des 2. Artikel stehen
supplier
Name des Lieferanten
purchasing_price
Preis zur Lagerbewertung
Fehlermeldungen+Erfolgsmeldungen
Bei einem erfolgreichen Aufruf des API's wird ein http-status 200 gesendet.
Wenn der Aufruf nicht erfolgreich war, wird ein http-status 401 gesendet.
Folgende Fehlermeldungen sind möglich:
"message": "No data received" / status 401
api hat keine Daten erhalten
"message": "Could not convert json" / status 401
api konnte Daten nicht als Json erkennen
"message": "key is missing" / status 401
api hat keinen key-wert gefunden
"message": "privatkey is missing" / status 401
api hat keinen privatkey-wert gefunden
"message": "your_email is missing" / status 401
api hat keinen email-wert gefunden
"message": "api_name is missing" / status 401
api hat keinen api-name-wert gefunden
"message": "order-API has not been sent with POST-methode" / status 401
Order-api muss mit POST-Method gesendet werden
"message": "key is wrong" / status 401
key-wert ist falsch
"message": "your privatkey or email is wrong" / status 401
privatkey oder email ist falsch
"message": "all ANZAHL records have been uploaded" / status 200
api-call war werfolgreich
"not in database": "Artikelnummer" / status 200
api-call war werfolgreich, aber einige Artikelnummern sind unbekannt