PharmaPortal Offerteaanvragen afwijzen API

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

Met dit endpoint kunt u een aanvraag afwijzen

Test API endpoint:
https://demo.pharma-portal.nl/api/offerte-aanvraag/afwijzen/[id van aanvraag]

Productie API endpoint:
https://www.pharma-portal.nl/api/offerte-aanvraag/afwijzen/[id van aanvraag]

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

x-portal-hmac HMAC van het bericht, SHA512, hexadecimaal, gegenereerd met de aan uw organisatie uitgereikte API secret

Request

Requests zijn POST requests.

Velden
  • reden De reden voor het afwijzen van de offerte. Wordt opgeslagen in PharmaPortal en in ZAGIS (zichtbaar voor ziekenhuizen). Max 250 karakters. Verplicht, maar mag leeg zijn
  • toelichting Een uitgebreide toelichting die wordt gemaild naar het ziekenhuis. Max 25000 karakters. Plaintext. Niet verplicht
Response

Deze API retourneert de volgende HTTP status codes:

  • 400 Geen POST request
  • 401 Bij foutieve authenticatie of HMAC
  • 404 Ongeldig aanvraag id
  • 200 Ronde is gesloten
  • 200 Ronde is al eerder gesloten (ter voorkoming dubbele requests, er wordt geen update verstuurd naar ZAGIS)

Voorbeeld van een response bij een succesvol & correct request: 

ok
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.