LPL-lijsten¶

GET Haal de actieve LPL-lijsten, inclusief deelnemers, op uit PharmaPortal.

Voor gebruikers van PharmaPortal is het mogelijk om via een API vanuit een eigen systeem de actieve LPL-lijsten, inclusief deelnemers, op te vragen uit PharmaPortal. Dit is een REST-API met één endpoint.

Toegang

Alleen beschikbaar voor licentiehouders van PharmaPortal.

Endpoint¶

TestProductie

GET https://demo.pharma-portal.nl/api/leverancier-prijs-lijst/overzicht

GET https://www.pharma-portal.nl/api/leverancier-prijs-lijst/overzicht

Authenticatie¶

Deze API maakt gebruik van IP-whitelisting en een API-key voor authenticatie en rate-limiting. Stuur de header mee:

Header	Toelichting
`x-portal-key`	De aan uw organisatie uitgereikte API-key.

Request¶

Requests zijn GET-requests.

curl https://demo.pharma-portal.nl/api/leverancier-prijs-lijst/overzicht \
  -H "x-portal-key: <uw-api-key>"

Response¶

Code	Betekenis
`200`	Correct request.
`401`	Foutieve authenticatie of HMAC.

Voorbeeld van een response bij een succesvol en correct request:

[
    {
        "id": 15,
        "titel": "Lijstnaam",
        "omschrijving": "Omschrijving",
        "isGepubliceerdInZAGIS": true, // of false
        "deelnemers": [67123, 67124, 67125], // PI-Codes voor wie de lijst zichtbaar is
        "prijzen": [
            {
                "zindexNummer": 12345678,
                "prijs": 123.45,
                "actiefVan": "YYYY-MM-DD",
                "actiefTot": "YYYY-MM-DD",
                "levering": "direct" // of "groothandel"
            },
            {
                "zindexNummer": 23456789,
                "prijs": 123.45,
                "actiefVan": "YYYY-MM-DD",
                "actiefTot": "YYYY-MM-DD",
                "levering": "groothandel" // of "direct"
            }
        ],
        "createdAt": "YYYY-MM-DD HH:mm:ss",
        "updatedAt": "YYYY-MM-DD HH:mm:ss"
    }
]

Velden¶

Veld	Type	Omschrijving
`id`	integer	Uniek ID van de lijst.
`titel`	string	Naam van de lijst.
`omschrijving`	string	Omschrijving van de lijst.
`isGepubliceerdInZAGIS`	boolean	Of de lijst is gepubliceerd in ZAGIS.
`deelnemers`	int[]	PI-Codes voor wie de lijst zichtbaar is.
`prijzen`	object[]	Prijzen per Z-Indexnummer (zie hieronder).
`prijzen[].zindexNummer`	integer	Z-Indexnummer van het artikel.
`prijzen[].prijs`	number	Prijs.
`prijzen[].actiefVan`	string	Datum vanaf wanneer de prijs actief is.
`prijzen[].actiefTot`	string	Datum tot wanneer de prijs actief is.
`prijzen[].levering`	string	`direct` of `groothandel`.
`createdAt`	string	Datum en tijd van aanmaken.
`updatedAt`	string	Datum en tijd van laatste wijziging.

Aandachtspunten

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