Contracten op peildatum¶

GET Haal de lijst met actieve contracten op peildatum op uit PharmaPortal.

Voor gebruikers van PharmaPortal is het mogelijk om via een API vanuit een eigen systeem de lijst met actieve contracten op peildatum op te vragen. Dit is een REST-API met één endpoint en één actie (met of zonder peildatum).

Toegang

Alleen beschikbaar voor licentiehouders van PharmaPortal.

Endpoint¶

TestProductie

GET https://demo.pharma-portal.nl/api/contracten/lijst
GET https://demo.pharma-portal.nl/api/contracten/lijst/[peildatum 1]/[peildatum 2]

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

Aanroepen zonder [peildatum 1] geeft de actieve contracten op de huidige datum. Aanroepen met [peildatum 2] geeft de actieve contracten tussen peildatum 1 en peildatum 2.

Parameter	In	Type	Verplicht	Omschrijving
`peildatum 1`	pad	string (`YYYY-MM-DD`)	nee	Actieve contracten op deze peildatum. Weglaten geeft de huidige datum.
`peildatum 2`	pad	string (`YYYY-MM-DD`)	nee	Actieve contracten tussen peildatum 1 en peildatum 2. Weglaten geeft de contracten actief op peildatum 1.

Limieten

Voor dit endpoint gelden de volgende limieten:

De periode tussen peildatum 1 en peildatum 2 mag maximaal 1 jaar zijn.
Peildatum 2 mag niet vóór peildatum 1 liggen.
Het resultaat mag maximaal 1000 contracten bevatten.

Buiten deze limieten geeft het endpoint een 400-response met een foutmelding in JSON. Voor grotere periodes of resultaten is er de gepagineerde v2-API.

Authenticatie¶

Deze API maakt gebruik van IP-whitelisting voor beveiliging en een API-key voor authenticatie & 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/contracten/lijst \
  -H "x-portal-key: <uw-api-key>"

Response¶

Code	Betekenis
`200`	Correct request.
`400`	Ongeldige datum, ongeldige periode, of meer dan 1000 resultaten (zie limieten hierboven). Body: `{"result":"error","errorMessage":"…"}`.
`401`	Foutieve authenticatie of HMAC.

Voorbeeld van een succesvolle response:

[
    {
        "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"
    }
]

Velden¶

Veld	Type	Omschrijving
`startDatum`	string	Startdatum van het contract.
`eindDatum`	string	Einddatum van het contract.
`opmerkingen`	string	Opmerking.
`piCode`	integer	PI-Code van de partij.
`zindexNummer`	integer	Z-Index-nummer van het artikel.
`isExclusief`	boolean	Exclusief contract (`true`/`false`).
`prijsPerVerpakking`	number	Prijs per verpakking, bij vaste prijs.
`kortingPercentage`	number	Kortingspercentage t.o.v. AIP, bij korting.
`soortAfspraak`	integer	`1` = Vaste prijs, `2` = Korting t.o.v. AIP.
`herkomst`	string	Herkomst.
`leveringVia`	integer	`1` = Direct, `2` = Groothandel.
`isLPL`	boolean	`true`/`false`.
`trajectSlug`	string	Slug van het traject.
`contractGroep`	string	ID van de contractgroep.
`contractGroepVolume`	integer	Afgegeven volume van de volledige contractgroep.
`createdAt`	string	Aanmaakmoment (`YYYY-MM-DD HH:mm:ss`).
`updatedAt`	string	Wijzigingsmoment (`YYYY-MM-DD HH:mm:ss`).

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.