Promail REST API 2.0 ist ein einfacher Wege um Daten mit der Promail Plattform auszutauschen und zu bearbeiten.
Mit dem "Retouren - API" können pro Retoure; Artikeldaten, Retourengrund und Grading abgerufen 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
Die Anfragen können an die url https://www.deal1.ch/PromailRESTreturnV1.php geschickt werden.
Json
Die Antworten werden in der JavaScript Sprache "Json" retourniert.
Beispiele unten.
GET
Das API reagiert auf die API Send-Methoden und steuert unterschiedliche Funktionen an.
Für Retouren muss die Methode GET verwendet werden.
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. Als GET Abfrage werden die Zugriffsschlüssel wie folgt verwendet: https://www.deal1.ch/PromailRESTreturnV1.php?partner=Key*PrivatKey:Your_Email&data=2021-01-31
Wenn ein Datum "data=2021-01-31" mit übergeben wird, werden bis 50 Retouren ab diesem Datum ausgelesen. Ohne Datum-Feld werden die letzten 50 Retouren ausgelesen.
GET Retouren abfragen
Im folgenden PHP-Beispiel-Code wird eine Abfrage mit cURL übermittelt:
Grading "A" = Produkt kann wieder verkauft werden
Grading "B" = Produkt braucht ein Rework, damit es wieder verkauft werden kann
Grading "C" = Produkt kann nicht wieder verkauft werden (defekt oder angebraucht)
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": "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": "order-API has not been sent with GET-methode" / status 401
Order-api muss mit GET-Method gesendet werden
"message": "key is wrong" / status 401
key-wert ist falsch
"message": "your privatkey or email is wrong" / status 401