PharmaPortal Contracten API

Voor gebruikers van PharmaPortal is het mogelijk om via een API vanuit een eigen systeem de lijst met actieve contracten op peildatum 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/contracten/lijst
https://demo.pharma-portal.nl/api/contracten/lijst/[peildatum 1]/[peildatum 2]

Productie API endpoint:
https://www.pharma-portal.nl/api/contracten/lijst
https://www.pharma-portal.nl/api/contracten/lijst/[peildatum 1]/[peildatum 2]

Aanroepen zonder "/[peildatum 1]" geeft de actieve contracten op de huidige datum. peildatum 1 en peildatum 2 zijn in het format "YYYY-MM-DD"

Aanroepen met "/[peildatum 2]" geeft de actieve contracten tussen peildatum 1 en peildatum 2

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: 

[
    {
        "startDatum": "YYYY-MM-DD",
        "eindDatum": "YYYY-MM-DD",
        "opmerkingen": "opmerking",
        "piCode": 671234,
        "zindexNummer": 12345678,
        "isExclusief": true, // of false
        "prijsPerVerpakking": 1.23, // Bij vaste prijs
        "kortingPercentage": 50, // 50%, bij korting tov AIP
        "soortAfspraak": 1, // 1 = Vaste prijs, 2 = Korting tov AIP
        "herkomst": "Herkomst",
        "leveringVia": 1, // 1 = Direct, 2 = Groothandel
        "isLPL": false, // of true
        "trajectSlug": "1-trajectnaam",
        "contractGroep" => "ID van contractgroep",
        "contractGroepVolume" => 100, // Afgegeven volume van volledige contractgroep
        "createdAt" "YYYY-MM-DD HH:mm:ss",
        "updatedAt": "YYYY-MM-DD HH:mm:ss"
    },
    {
        "startDatum": "YYYY-MM-DD",
        "eindDatum": "YYYY-MM-DD",
        "opmerkingen": "opmerking",
        "piCode": 671234,
        "zindexNummer": 12345678,
        "isExclusief": true, // of false
        "prijsPerVerpakking": 1.23, // Bij vaste prijs
        "kortingPercentage": 50, // 50%, bij korting tov AIP
        "soortAfspraak": 1, // 1 = Vaste prijs, 2 = Korting tov AIP
        "herkomst": "Herkomst",
        "leveringVia": 1, // 1 = Direct, 2 = Groothandel
        "isLPL": false, // of true
        "trajectSlug": "1-trajectnaam",
        "contractGroep" => "ID van contractgroep",
        "contractGroepVolume" => 100, // Afgegeven volume van volledige contractgroep
        "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.