Information
- License: Apache-2.0
- OpenAPI version:
3.1.0
Overview
Buildinglinks backend contract 1.0
Section titled “Buildinglinks backend contract 1.0”What the backend system of a datahouder implements: the Buildinglinks protocol v1 (buildinglinks_version 1.0). The participant’s data plane calls it for the requests of dataontvangers, within their agreements, and the connector calls it to discover the points and the layout of a building. Callers come from the participant’s own infrastructure; requests arrive as the dataontvanger sent them, with only the building id replaced when the binding (koppeling) knows the building by another id.
Every response carries buildinglinks_version and building_id. With Accept: application/ld+json the answer is JSON-LD: the same message with an @context line. Failures use the error body, with a stable code and retryable. A write is answered with 202 and a receipt, also when some items are rejected; a request that fails as a whole is an error. Query parameters are strict: an unknown parameter is an invalid_request.
Authentication
Section titled “Authentication”bindingKey
Section titled “bindingKey”The key of the binding (bron) in the connector: the header name (auth_header_name, here X-Api-Key as an example) and its value (auth_header_value), sent with every request. A koppeling may give a building a key of its own, which then replaces the system’s key for that building. A backend without a key leaves both empty.
Security scheme type: apiKey
Header parameter name: X-Api-Key