Authentication
Access to the Gemeinde-Connect Legacy API is secured using API Keys, submitted as Ocp-Apim-Subscription-Key
All requests must include a valid API key in the HTTP header.
Obtaining an API key
API keys are not self-service.
To obtain access, please contact support. As part of the onboarding process, you will be issued with a set of API keys for your integration.
Issued API keys
Each integration receives four (4) API keys:
2 x API Keys for Test / Development environment
2 x API Keys for Production environment
Using the API key
The API key must be sent in the following HTTP header:
Ocp-Apim-Subscription-Key
The key identifies your integration and authorizes access to the Legacy API.
Bearer token (legacy compatibility)
Some existing integrations may still send an additional header Authorization: Bearer <token>
This header is still accepted for compatibility
Only the Ocp-Apim-Subscription-Key is mandatory
API key rotation
API key rotation is supported and handled via support request.
Rotation process
You will be issued 4 new API keys (2 Test/Dev, 2 Production)
Existing keys remain active during the transition period
Once the new keys have been deployed on your side, the old keys can be deactivated