PharmaPortal Claims lijst API

Voor gebruikers van PharmaPortal is het mogelijk om via een API vanuit een eigen systeem de lijst met ingelezen claims op te vragen uit PharmaPortal.

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

Test API endpoint:
https://demo.pharma-portal.nl/api/claims/list/[jaar]

Productie API endpoint:
https://www.pharma-portal.nl/api/claims/list/[jaar]

Bij het leeglaten van het [jaar] argument wordt automatisch het huidige jaar gebruikt.

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:

{
  "jaar": "2019",
  "numClaims": 2,
  "claims": [
    {
      "GroothandelPiCode": "871079",		# PI code verwijzend naar de groothandel
      "ControleResultaat": "3",				# 1 = Correct, 2 = Geaccepterd met verschillen, 3 = Wacht op correctie, 4 = Correctie ontvangen, 5 = In behandeling
      "LaatsteControleOp": null,			# Moment van laatste controle door gebruiker
      "ClaimType": "W",						# Type bestand conform FIX specificatie
      "Volgnummer": "44",					# Volgnummer van het bestand, aangegeven door de groothandel
      "NaamAfzender": "Brocacef BV BCF Zorglogistiek",	# Naam van de afzender, aangegeven door de groothandel
      "BestandsDatum": "2019-02-01",		# Datum waarop het bestand is aangemaakt door groothandel
      "Slug": "8711722006004-1-brocacef-2"	# Uniek ID om claimregels via API op te halen
    },
    {
      "GroothandelPiCode": "871079",
      "ControleResultaat": "2",
      "LaatsteControleOp": null,
      "ClaimType": "W",
      "Volgnummer": "44",
      "NaamAfzender": "Brocacef BV BCF Zorglogistiek",
      "BestandsDatum": "2019-02-01",
      "Slug": "8711722006004-1-brocacef-3"
    }
]
}
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.