πŸ’š Pilot
WIP
Developer Portal β€” Pilot

Building the future of the
TI developer experience.

Welcome to the gematik Developer Portal pilot. Currently featuring the VSDM 2.0 API, this portal gives you interactive documentation, a mock server, contract testing, and code generation β€” everything you need to integrate with the Telematikinfrastruktur. More APIs will follow based on your feedback.

Core Features

Three pillars of the
TI developer experience.

From interactive API exploration to contract testing and automated quality gates β€” everything you need to build reliable TI integrations.

API Portal

Explore the VSDM2 API with interactive documentation powered by SwaggerHub. Try endpoints directly in the browser, use the built-in mock server, and generate client code in your preferred language.

  • Interactive API docs with "Try It Out"
  • Mock Server (Prism-based) for simulated responses
  • API Catalog & Discovery
  • SDK / Code Generation (Java, C#, Go, Python, …)
  • OpenAPI spec downloads (with & without ZETA)
Open API Portal

Contract Testing

Validate your integrations against official gematik API contracts using Pact. Publish your consumer contracts to our PactFlow broker and get automated compatibility verification against the provider.

  • Bidirectional Contract Testing (Pact)
  • CI/CD pipeline integration
  • Automated compliance & breaking change detection
  • Detailed compatibility reports
Learn more

API Lifecycle Managment

Behind the scenes, our automated API lifecycle pipeline ensures every published API meets strict quality standards β€” from FHIR source to validated OpenAPI specification.

  • FHIR β†’ OpenAPI generation (custom tooling)
  • OpenAPI Overlays for environment configs
  • Automated linting (Spectral) & validation
  • Continuous publishing to API Portal
Learn more
Getting Started

How to use the Developer Portal

This pilot currently features the VSDM 2.0 API. More APIs will be added based on your feedback. Here's how to get the most out of each tool.

1

Explore the API Portal

The API Portal contains all API descriptions generated and validated by our toolchain. Currently it features the VSDM 2.0 pilot project. The portal provides:

  • A SwaggerHub Auto Mocking Server that simulates VSDM2 API responses
  • Server environments for REF, TU and PU (currently listed as reference only)
  • Code samples in Java, C#, Go, JavaScript, PHP, Python, Scala, Swift and more
  • Multiple example responses for each endpoint

The code generator has been tested for Java, C# and TypeScript. You can also integrate the openapi-generator into your own codebase to generate HTTP clients and model classes. This reduces manual implementation effort on the client side and ensures consistent API usage. If you experience issues or would like us to test additional languages, please let us know!

2

Download OpenAPI Specifications

Every time a new VSDM2 FHIR specification is published, our CI/CD pipeline automatically generates an updated OpenAPI specification. Two variants are available:

VSDM2 with ZETA

The ZETA-Guard to Resource Server interface, including all HTTP headers required for access via the ZETA Guard. Use this for understanding the full TI 2.0 interface requirements and building API routing without the ZETA SDK.

View on API Portal β†’

VSDM2 without ZETA

The pure Client to ZETA-Guard interface without the ZETA overlay. Use this for preparing and validating payloads to be processed by the ZETA SDK.

View on API Portal β†’
3

Set Up Contract Testing

Use Pact, an open-source contract testing framework, to validate service interactions without relying on complex end-to-end tests. Recommended workflow:

  1. Verify your tech stack supports Pact
  2. Download the OpenAPI spec and use it as the basis for a mock server
  3. Write Pact tests covering your expected interactions
  4. Generate a Pact file (pact.json) and publish it to our broker

See the Java example implementation and the VsdmClientServicePactTest in our TestHub for a consumer-side Pact test reference.

Broker Registration

Contact us with your desired application name for the Pact Broker. We will provide you with two API tokens: a Read/Write token for your CI/CD pipelines and a Read-Only token for reports and dashboards.

CONTRACT_BROKER_URL=https://gematik.pactflow.io
APP_NAME=my-application-name

Publish Contract

Upload your generated pact.json (Base64-encoded) using the following parameters. The possible values for PROVIDER_APPLICATION_NAME are:

  • vsdm2-zeta-gematik-reference β€” VSDM2 with ZETA overlay
  • vsdm2-gematik-reference β€” VSDM2 without ZETA overlay
APP_VERSION=v1.0.0                              # use Semantic Versioning
APP_BRANCH=main                                  # optional
APP_BUILD_URL=https://ci.example.org/build/123   # optional
PROVIDER_APPLICATION_NAME=vsdm2-zeta-gematik-reference

The generated pact.json file must be Base64-encoded before uploading:

PACT_B64=$(base64 -w 0 pact.json)

curl -X POST "$CONTRACT_BROKER_URL/contracts/publish" \
  -H "Content-Type: application/json" \
  -H "Accept: application/hal+json" \
  -H "Authorization: Bearer <API_KEY_READ_WRITE>" \
  -d '{
    "pacticipantName": "'$APP_NAME'",
    "pacticipantVersionNumber": "v1.0.0",
    "branch": "main",
    "contracts": [{
      "consumerName": "'$APP_NAME'",
      "providerName": "vsdm2-zeta-gematik-reference",
      "content": "'$PACT_B64'",
      "contentType": "application/json",
      "specification": "pact"
    }]
  }'
Resources

Everything at your fingertips.

From specifications to code examples β€” find all the resources you need in one place.

Project Resources

Where to find Project Resources

Find FHIR profiles, API documentation, and specifications for the projects relevant to the VSDM2.0 pilot project. Use this table to jump directly to the right place.

Project IG / API Docs FHIR Profiles (Packages) Specification
Versichertenstammdatenmanagement 2.0 (VSDM 2.0) spec-VSDM2 (GitHub) VSDM2 gemSpec_VSDM_2
Zero Trust Access (ZETA) zeta (GitHub) β€” gemSpec ZETA
Proof of Patient Presence (PoPP)-Service api-popp-service (GitHub) β€” gemSpec_PoPP_Service
Ecosystem

Part of a bigger ecosystem.

The gematik developer ecosystem extends across multiple platforms. Here's where to find what you need.

Ready to start building?

Dive into the Developer Portal and start integrating with the Telematikinfrastruktur today. Access APIs, run contract tests, and ship with confidence.