Koppeling nieuwe webwinkelplatform: Noodzakelijke voorwaarden API webwinkelplatform

Bij het koppelen naar een nieuw webwinkelsysteem dient de API van het webwinkelplatform aan de volgende voorwaarden te voldoen:

  1. We koppelen alleen met REST API.
  2. De webwinkel moet online benaderbaar zijn. Wij koppelen niet met hybride systemen waarbij alleen de bestellingen online beschikbaar zijn. De reden is dat dit de supportprocessen te zwaar zou belasten.
  3. De REST API dient gedocumenteerd te zijn. In het bijzonder dient de omschrijving van de velden en het feit of een veld verplicht is, te zijn gedocumenteerd.
  4. Authenticatie bij voorkeur met OAuth. Een voorbeeld van het opzetten van OAuth met alle requests dient uitgeschreven te zijn.
  5. Er dienen endpoints te zijn voor:
    1. Debiteuren - zoeken op emailadres
    2. Verkopen - zoeken op id en periode, bij voorkeur ook zoeken op nummer
    3. De verkoopregels zijn voorzien van BTW informatie
    4. Verzendkosten, betaalkosten, kortingen en toeslagen zijn voorzien van BTW informatie
    5. Producten - zoeken op id en op SKU
    6. BTW tarieven zijn op te halen uit de webwinkel
    7. Betaalmethoden zijn op te halen uit de webwinkel
    8. Bij het wijzigen van een bestelling wordt het bestel-id niet gewijzigd
  6. Responses vanuit de webwinkel dienen aan te geven of een request geslaagd of niet geslaagd is.
  7. Is een actie niet geslaagd dan is de HTTP response code 400 en bevat de response een omschrijving van wat er verkeerd is gegaan
  8. Er zijn ruime API limieten of het moet mogelijk zijn om de ruimte binnen de API limiet te berekenen.
Labels: koppelen webwinkel