Dibito REST API (1.1)

The Dibito REST API provides services to submit, verify and deliver eBills. The API is designed to be used by biller integrations.

Product Website

https://www.dibito.ch

API Key

This API requires an API key to be passed in the `X-API-Key` header.
Generate your API key in the Dibito application under "Dibito -> API Keys".

Further Informations

Consult our documentation for futher informations about creating and handling eBills.
Download OpenAPI description
api-docs.json
api-docs.yaml
Overview
URL

https://www.codeblock.ch

Codeblock GmbH

contact@codeblock.ch

Languages
Servers
Generated server url

https://app.dibito.ch/

00 Examples

Operations

10 Business Cases

Operations

20 Bill Recipients

Operations

21 Bill-Recipient Subscriptions

Operations

30 Events

Operations

31 SIX Events

Operations

40 Webhook Management

Operations

90 PDF

Operations

98 Health Check

Operations

eBill platform health check

Request

Returns a status message of the eBill system managed by SIX

Security
X-API-Key
curl -i -X GET \
  https://app.dibito.ch/api/v1/healthcheck/ebill \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Healthcheck successful

Bodyapplication/json
messagestring[ 0 .. 100 ] charactersrequired

response message from health check

Example: "The healthcheck GET request was successfully received and processed"
requestDateTimestring(date-time)required

according to RFC3339, section 5.6 in ISO 8601 with timezone and milliseconds

Example: "2018-10-03T16:03:09.101+02:00"
receivedHeadersArray of objects(HealthCheckResponseReceivedHeaders)required
receivedHeaders[].​headerNamestring

the name of the provided header

Example: "x-correlation-id"
receivedHeaders[].​headerValuestring

As received

Example: "9bcd4351-4b7b-4017-9b63-9613414c6ff1"
environmentStagestringrequired

the instance which the request was sent to

Example: "XE"
applicationVersionstringrequired

the version of the eBill infrastructure

Example: "1.4.3.0-desire-20180927091004161-71-5e3ca91"
apiVersionstringrequired

the version of the network partner api

Example: "1.0.23"
maintenanceWindowsArray of objects(MaintenanceWindow)

Information about the upcoming maintenance windows. If no maintenance is planned, an empty list is returned.

Response
application/json
{
  "message": "The healthcheck GET request was successfully received and processed",
  "requestDateTime": "2018-10-03T16:03:09.101+02:00",
  "receivedHeaders": [
    { … }
  ],
  "environmentStage": "XE",
  "applicationVersion": "1.4.3.0-desire-20180927091004161-71-5e3ca91",
  "apiVersion": "1.0.23",
  "maintenanceWindows": [
    { … }
  ]
}

99 Authentication

Operations

webhooks

Webhooks

endpoint-controller

Operations