Ga naar inhoud

Offerteaanvragen — lijst

GET Haal een lijst van offerteaanvragen op uit PharmaPortal.

Voor gebruikers van PharmaPortal is het mogelijk om via een API vanuit een eigen systeem offerteaanvragen op te vragen. Dit is een REST-API met één endpoint en drie varianten (actief, afgerond, alle).

Toegang

Alleen beschikbaar voor licentiehouders van PharmaPortal.

Endpoint

GET https://demo.pharma-portal.nl/api/offerte-aanvraag/actief
GET https://demo.pharma-portal.nl/api/offerte-aanvraag/afgerond
GET https://demo.pharma-portal.nl/api/offerte-aanvraag/alle

GET https://www.pharma-portal.nl/api/offerte-aanvraag/actief
GET https://www.pharma-portal.nl/api/offerte-aanvraag/afgerond
GET https://www.pharma-portal.nl/api/offerte-aanvraag/alle
Variant Levert op
actief Lopende offerteaanvragen.
afgerond Afgeronde offerteaanvragen.
alle Alle offerteaanvragen.

Authenticatie

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

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

Request

curl https://demo.pharma-portal.nl/api/offerte-aanvraag/actief \
  -H "x-portal-key: <uw-api-key>"

Response

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

Voorbeeld van een succesvolle response:

[
  {
    "id": "ronde-3077",
    "naam": "Testronde",
    "status": "nieuw"
  },
  {
    "id": "groep-6556",
    "naam": "Testgroepsronde",
    "status": "offerte ingediend"
  }
]

Velden

Veld Type Omschrijving
id string ID waarmee details kunnen worden opgevraagd.
naam string Naam van de ronde.
status string Zie de tabel hieronder.

Mogelijke statussen: nieuw, offerte ingediend, besluitvorming afgerond, afgerond, afgerond, geen offerte uitgebracht.

Aandachtspunten

Wilt u uw integratie testen? Neem tijdig contact op via info@zagis.nl voor testdata en een API-key.