Ga naar inhoud
buildinglinksbuildinglinks

What this connector is

GET
/api/v1/self
curl --request GET \
  --url https://example.com/api/v1/self

Public: the participant’s name, DID and endpoints, the onboarding state, the version and the environment. The login page shows it, and bl uses it to recognise a connector.

Authorizations

Section titled “Authorizations”
  • None

Responses

Section titled “Responses”

200

Section titled “200”

OK.

Media typeapplication/json

GET /api/v1/self: documents the JSON built in [self_info].

object
slug
required
string
name
required
string
color
required

The colour of the participant in the UI.

string
role
required

The participant’s role in the dataspace, e.g. datahouder.

string
configured
required

False on a fresh installation that has not been registered yet.

boolean
did
required
string
dsp_endpoint
required

The DSP endpoint other connectors call.

string
dataplane_public_url
required
string
dataplane_browser_url
required
string
authority_url
required
string
onboarding
required

not_started, awaiting_signature, pending, approved, active, rejected or suspended.

string
version
required
string
tck_mode
required

The connector runs for the DSP compatibility kit.

boolean
environment
required

production, test, dev, …

string
relaxations
required

Unsafe settings that are active in this environment.

Array<object>
object
building_service
required

A gebouwservice is configured (/api/building).

boolean

Example generated

{
  "slug": "example",
  "name": "example",
  "color": "example",
  "role": "example",
  "configured": true,
  "did": "example",
  "dsp_endpoint": "example",
  "dataplane_public_url": "example",
  "dataplane_browser_url": "example",
  "authority_url": "example",
  "onboarding": "example",
  "version": "example",
  "tck_mode": true,
  "environment": "example",
  "relaxations": [
    {}
  ],
  "building_service": true
}