ZAGIS Prijs API¶

POST Vraag de geldende prijs voor een specifiek product op.

Voor gebruikers van ZAGIS is het mogelijk om via een API vanuit een eigen systeem de geldende prijs voor een specifiek product op te vragen. Deze prijs-API is een REST-API met één endpoint en één mogelijke actie.

Toegang

Alleen beschikbaar voor gebruikers van ZAGIS.

Endpoint¶

TestProductie

POST https://demo.zagis.nl/api/zagis/prijsCheck

POST https://www.zagis.nl/api/zagis/prijsCheck

Authenticatie¶

Deze API maakt gebruik van:

IP-whitelisting voor beveiliging
Een API-key voor authenticatie & rate-limiting
HMAC voor integriteitscontrole

Stuur de volgende headers mee:

Header	Toelichting
`x-zagis-key`	De aan uw organisatie uitgereikte API-key.
`x-zagis-hmac`	Hexadecimaal geëncodeerde SHA-512 HMAC van het request body.

Request¶

Requests zijn POST-requests met een JSON-payload:

{
    "zindexNummer": 12345678, // Het Z-Index nummer van het te controleren artikel
    "route": "direct", // 'direct' of 'groothandel'
    "datum": "01-01-2018" // Datum in nederlandse notatie waarvoor de geldende prijs wordt bepaald
}

curl -X POST https://demo.zagis.nl/api/zagis/prijsCheck \
  -H "x-zagis-key: <uw-api-key>" \
  -H "x-zagis-hmac: <hmac>" \
  -d '{"zindexNummer": 12345678, "route": "direct", "datum": "01-01-2018"}'

Response¶

Code	Betekenis
`200`	Correct request.

Voorbeeld van een response bij een succesvol & correct request:

{
    "result" : "success",   // 'success' of 'error'
    "errorMessage" : "",    // Error message bij fout
    "errorCode" : 0,        // Error code bij fout
    "zindexNummer" : "12345678", // Het gecontroleerde Z-Index nummer
    "route" : "direct", // De gecontroleerde leveringswijze
    "datum" : "01-01-2018", // De gecontroleerde datum
    "soortPrijs" : "aip", // aip, gip of contract
    "basisPrijsVerpakking" : 0, // Kale prijs ex BTW per verpakking
    "toeslagenVerpakking" : 0, // Toeslagen totaal per verpakking
    "btwBedrag" : 0, // BTW per verpakking
    "btwPercentage" : 0, // Geldend BTW percentage bij inkoop
    "totaalPrijsVerpakkingExBtw" : 0, // Totale prijs ex BTW per verpakking
    "totaalPrijsVerpakkingIncBtw" : 0, // Totale prijs inc BTW per verpakking
    "verpakkingsHoeveelheid" : 0, // Aantal counting units (tabletten/ampullen/flacons etc) per verpakking
    "aantalBasiseenheden" : 0, // Aantal basiseenheden (tabletten/mililiters/eenheden) per verpakking
    "contractPartij" : "", // Leveranciernaam van het artikel (Contractpartij bij contract, "Groothandel" bij GIP, Registratiehouder bij AIP)
    "contractPartijNaam" : "", // Leveranciernaam van het artikel (Contractpartij bij contract, "Groothandel" bij GIP, Registratiehouder bij AIP)
    "contractPartijNummer" : "", // G-Standaard NAW-Nummer van het artikel (Contractpartij bij contract, leeg bij GIP, Registratiehouder bij AIP)
    "artikelIsActief" : false, // Is artikel actief in de G-Standaard
    "artikelUnKode" : "", // UN kode uit de G-Standaard bij een vervallen artikel
    "artikelUnDatum" : "", // Datum waarop UN kode ingaat bij een vervallen artikel
    "ziekenhuis" : "" // Naam van het ziekenhuis
}

Voorbeeld van een response bij een inhoudelijk foutief request:

{
    "result": "error",
    "errorMessage": "Onbekend Z-Index nummer",
    "errorCode": 2
}

Velden¶

Veld	Type	Omschrijving
`result`	string	`success` of `error`.
`errorMessage`	string	Error message bij fout.
`errorCode`	integer	Error code bij fout.
`zindexNummer`	string	Het gecontroleerde Z-Index nummer.
`route`	string	De gecontroleerde leveringswijze.
`datum`	string	De gecontroleerde datum.
`soortPrijs`	string	`aip`, `gip` of `contract`.
`basisPrijsVerpakking`	number	Kale prijs ex BTW per verpakking.
`toeslagenVerpakking`	number	Toeslagen totaal per verpakking.
`btwBedrag`	number	BTW per verpakking.
`btwPercentage`	number	Geldend BTW percentage bij inkoop.
`totaalPrijsVerpakkingExBtw`	number	Totale prijs ex BTW per verpakking.
`totaalPrijsVerpakkingIncBtw`	number	Totale prijs inc BTW per verpakking.
`verpakkingsHoeveelheid`	number	Aantal counting units (tabletten/ampullen/flacons etc) per verpakking.
`aantalBasiseenheden`	number	Aantal basiseenheden (tabletten/mililiters/eenheden) per verpakking.
`contractPartij`	string	Leveranciernaam van het artikel (Contractpartij bij contract, "Groothandel" bij GIP, Registratiehouder bij AIP).
`contractPartijNaam`	string	Leveranciernaam van het artikel (Contractpartij bij contract, "Groothandel" bij GIP, Registratiehouder bij AIP).
`contractPartijNummer`	string	G-Standaard NAW-Nummer van het artikel (Contractpartij bij contract, leeg bij GIP, Registratiehouder bij AIP).
`artikelIsActief`	boolean	Is artikel actief in de G-Standaard.
`artikelUnKode`	string	UN kode uit de G-Standaard bij een vervallen artikel.
`artikelUnDatum`	string	Datum waarop UN kode ingaat bij een vervallen artikel.
`ziekenhuis`	string	Naam van het ziekenhuis.

Aandachtspunten

ZAGIS kent aparte prijsafspraken voor levering via groothandel en directe levering. Het controlerende systeem moet per request zelf bepalen welke prijs wordt opgevraagd.

Wilt u uw integratie testen? Neem tijdig contact met ons op via info@zagis.nl. Wij zetten dan testdata voor u klaar en voorzien u van een API-key.