Skip to content

Pharma-Intelligence API documentation

Welcome to the Pharma-Intelligence APIs. These APIs connect your own systems to ZAGIS, PharmaPortal, Pharma-Insights and PiDentity.

  • ZAGIS

    Prices, consumption and GIP data. Available to ZAGIS licence holders only.

  • PharmaPortal

    Quotation requests, claims, contracts and more. PharmaPortal licence holders only.

  • Pharma-Insights

    Delivery of billing records by hospitals. Institutions with an Insights licence only.

  • PiDentity

    Universal organisation identification (PI-Code). Available to all parties.

Getting started

Each product (ZAGIS, PharmaPortal, Pharma-Insights, PiDentity) has its own base URL and its own authentication. The principles below apply to all APIs; the per-product details are in the tables underneath.

1. Request access

The ZAGIS and PharmaPortal APIs are available to licence holders only. Contact us in good time at info@zagis.nl. We will:

  • prepare test data for you;
  • issue an API key;
  • add your server IP to the whitelist.

For Pharma-Insights, request an API key via vragen@pharma-insights.nl. A test environment is not offered by default.

PiDentity is public and requires no access request.

2. Base URLs per product

Product Test Production
ZAGIS https://demo.zagis.nl https://www.zagis.nl
PharmaPortal https://demo.pharma-portal.nl https://www.pharma-portal.nl
Pharma-Insights on request https://www.pharma-insights.nl
PiDentity https://pidentity.pharma-intelligence.nl https://pidentity.pharma-intelligence.nl

3. Authentication per product

Product Security Headers
ZAGIS IP whitelisting + API key + HMAC x-zagis-key, x-zagis-hmac
PharmaPortal IP whitelisting + API key x-portal-key
Pharma-Insights PI-Code + API key x-picode, x-apikey
PiDentity None (public) Not applicable 
x-zagis-key: <your-api-key>
x-zagis-hmac: <HMAC of the request body>

x-portal-key: <your-api-key>

x-picode: <PI-Code of your institution>
x-apikey: <your-api-key>

No headers required.

See Computing the HMAC for example code (Python, PHP, C#, Node.js, Java) to generate the required HMAC header.

4. Status codes

All endpoints use the same convention:

Code Meaning
200 Request processed correctly.
401 Invalid authentication or HMAC.

Pharma-Insights additionally returns 400, 405 and 503; see the endpoint page.

Testing

Want to test a ZAGIS or PharmaPortal integration? Contact us in good time at info@zagis.nl and we will prepare test data and an API key for you.