PI - API Docs

PharmaPortal Offerteaanvragen lijst API

Voor gebruikers van PharmaPortal is het mogelijk om via een API vanuit een eigen systeem offerte-aanvragen op te vragen uit PharmaPortal.

Deze Offerte API is een REST api met 1 endpoint en 1 mogelijke actie

Test API endpoint:
https://demo.pharma-portal.nl/api/offerte-aanvraag/actief
https://demo.pharma-portal.nl/api/offerte-aanvraag/afgerond
https://demo.pharma-portal.nl/api/offerte-aanvraag/alle

Productie API endpoint:
https://www.pharma-portal.nl/api/offerte-aanvraag/actief
https://www.pharma-portal.nl/api/offerte-aanvraag/afgerond
https://www.pharma-portal.nl/api/offerte-aanvraag/alle

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": "ronde-3077",		# ID waarmee details kunnen worden opgevraagd
	"naam": "Testronde",		# Naam
	"status": "nieuw"		# nieuw/offerte ingediend/besluitvorming afgerond/afgerond/afgerond, geen offerte uitgebracht
}, {
	"id": "groep-6556",
	"naam": "Testgroepsronde",
	"status": "offerte ingediend"
}]

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.