PI - API Docs

PharmaPortal LPL API

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.

Deze API is een REST api met 2 endpoints en 1 mogelijke actie

Test API endpoint:
https://demo.pharma-portal.nl/api/leverancier-prijs-lijst/overzicht

Productie API endpoint:
https://www.pharma-portal.nl/api/leverancier-prijs-lijst/overzicht

Authenticatie

Deze API maakt gebruik van:

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

Headers

x-portal-key De aan uw organisatie uitgereikte API key

Request

Requests zijn GET requests.

Response

Deze API retourneert de volgende HTTP status codes:

401 Bij foutieve authenticatie of HMAC
200 Bij een correct request

Voorbeeld van een response bij een succesvol & correct request:

[
    {
        "id": 15,
        "titel": "Lijstnaam",
        "omschrijving": "Omschrijving",
        "isGepubliceerdInZAGIS": true, // of false
        "deelnemers": [67123, 67124, 67125], // PI Codes voor wie 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"
    }
]

Aandachtspunten

Indien u uw integratie wilt testen neemt u tijdig contact met ons op via info@zagis.nl. Wij zetten dan testdata voor u klaar en voorzien u van API-Key.