2. Automatisch importeren productlijst

Automatisch uploaden productlijst – stuur productlijst naar of laat productlijst ophalen door myShop.com

Hieronder vind je informatie hoe je de productlijst naar myShop.com kunt opsturen. Er zijn 2 manieren, stuur de lijst naar myShop.com toe of laat de lijst ophalen. Wij adviseren de eerste methode.

Stuur de productlijst naar myShop.com

Indien je deze optie kiest, moet je de volgende instellingen invullen:

• prive sleutel
  Deze sleutel is weergegeven.

• IP-adres (optioneel)
  Om te voorkomen dat vanaf elke computer een productlijst bijgewerkt kan worden is het mogelijk om een IP-adres op te geven. Tijdens het uploaden wordt dan gecontroleerd of het commando vanaf de juiste computer wordt gestart. Geef hier je eigen vaste IP-adres op om de beveiliging te activeren of laat dit veld leeg indien je geen controle op IP-adres wilt toepassen.
  Indien u uw IP-adres niet meer weet kun je dit achterhalen door zelf een bestelling te plaatsen in je winkel. Het IP-adres is dan te vinden in orderbeheer onder tabblad ‘orders’ , bij de detailinformatie van de zojuist geplaatste bestelling.

• Terugkoppeling
  Hier kan aangegeven worden welke terugkoppeling plaats moet vinden bij een upload commando (op welke momenten en op welke wijze).

• Trigger
  Hier kan aangegeven worden op welke momenten teruggekoppeld moet worden. Aangeraden wordt om bij het instellen van deze functie alle terugkoppeling mogelijkheden te activeren. Zo kan een goed inzicht verkregen worden in de werking. Als de automatische upload operationeel is dan kan de terugkoppeling beperkt – of uitgeschakeld worden.

Algemene werking

• Stap 1 opvragen van een rpc id
  De eerste stap bestaat uit het opvragen van een rpc id waarmee de aanvraag uitgevoerd kan worden.
  Let op!! Een rpc id is maximaal 2 minuten geldig na het moment van aanvragen. Na deze periode moet er een nieuwe rpc_id aangevraagd worden.
  Het opvragen van een rpc_id gaat met de request:
  https://www.mijnwinkel.nl/RPC/id?shop=12345
  Het veld shop mag daarbij niet leeg zijn en de winkel moet bestaan. Het resultaat van deze aanvraag is:
  rpc
  id1234567890 /id
  rpc

• stap 2 opvoeren oproep commando
  Een voorbeeld van een oproep commando is: https://www.mijnwinkel.nl/RPC/productlist/update?pk=9cdd655d6dd30cd38aa83aa76a60199d2afc1d68&productlist=2&shop=5627&filename=voorraadtest.zip&rpc_id=1234567890
  Het oproep commando moet de volgende query string parameters bevatten:

Naam parameter

• pk >publieke sleutel (zie info onder tabel)
• shop>nummer van de winkel
• productlist>product lijst nummer
• filename>naam van het te importeren zip bestand (nb: als je een zip file gebruikt, dan is de filename de naam van het gezipte bestand, niet de naam van de zip file)
• rpc_id>de waarde die je bij stap 1 gekregen heeft
  

Parameter PK

De parameter pk is een hash waarde die wordt samengesteld uit een tekenreeks die ontstaat als de volgende gegevens worden samengevoegd en daarvan de SHA1 waarde van wordt bepaald (n.b.: de SHA1 waarde moet in kleine letters worden weergegeven)

• shopnummer
• productlist nummer
• private key
• filenaam
• rpc_ id waarde
  

Direct na het opgeven van dit commando wordt de upload-opdracht bij in een wachtrij geplaatst en uitgevoerd zodra er voldoende capaciteit beschikbaar is, dit duurt ongeveer 30 seconden. Na het commando wordt via de browser een XML document getoond met informatie over de upload-opdracht. De upload-opdracht kan beveiligd worden door middel van een IP-adres controle en een key. Bij de start, tijdens de uitvoering en na afronding van de upload kan via email of een url aanroep de status worden gevolgd.

Bij de email terugkoppeling ontvang je de status van de opdracht als een email met een XML bericht. Het bericht wordt naar het email adres van de winkel gestuurd. Bij terugkoppeling via een url aanroep wordt het XML bericht met de status door middel van een POST van een formulier verzonden. Je kunt het bericht uitlezen door de waarde van de formulier parameter ‘jobstate’ op te vragen.

Voorbeeld upload productlijst

Een voorbeeld van het automatisch uploaden van de productlijst via de push functionaliteit vind je via deze link. Je krijgt een HTML page te zien van een simpel formulier waarin je informatie kunt opnemen om de push functionaliteit te laten werken. Zie ook de achterliggende HTML code.
NB: dit voorbeeld laat zien hoe het kan werken, in praktijk werkt het alleen via de mijnwinkel.nl server.

Status verzoek aanvraag

Het is van belang te weten of de vorige productlijst die je opgestuurd hebt, goed is verwerkt. Het opvragen van de status is belangrijk omdat er per winkel maar 1 productlijst tegelijk vernieuwd mag worden (met behulp van https://www.mijnwinkel.nl/RPC/productlist/update). Door de status af te vragen (nadat de tuid is verkregen), is het mogelijk om geautomatiseerd het moment te bepalen wanneer de volgende lijst verwerkt kan worden. Pas als je een status krijgt dat de upload goed is verwerkt, kun je een nieuwe productlijst opsturen.
Je kunt de volgende url aanroepen om de status van de aanvraag te krijgen:

https://www.mijnwinkel.nl/RPC/productlist/update_status?shop=1234&tuid=1234dhjdfgjjweujsdfjjksdfkj

De URL kent twee verplichte parameters:

• shop>nummer van uw shop
• tuid>het identificatie nummer van de opdracht
  De waarde van tuid (task identification number) staat in het XML document wat terug wordt gegeven als een productlijst update succesvol is aangevraagd (via https://www.mijnwinkel.nl/RPC/productlist/update?….).
  

Na het aanroepen van de status krijg je een status element terug, de volgende waarden zijn mogelijk:

• waiting – de opdracht voor het vernieuwen van de productlijst wacht op acceptatie
• scheduled – de opdracht voor het vernieuwen van de productlijst is geaccepteerd en zal uitgevoerd gaan worden
• processing – het vernieuwen van de productlijst wordt uitgevoerd
• done – het vernieuwen van de productlijst is afgerond.

met deze functie is het alleen mogelijk om bestanden in .zip formaat te uploaden (een .xls of .csv bestand dient dus eerst gezipt te worden)
met deze functie kan het te uploaden bestand niet direct vanaf de eigen computer ge-upload worden (dus altijd eerst via ftp het bestand op een webserver plaatsen)

Laat productlijst door myShop.com ophalen

Indien deze methode gebruikt wordt, moet je bij het veld van directory de folder opgeven waar de .zip file staat van de productlijst op de eigen server.