Skip to content

e-gov/PH

Repository files navigation

Public documentation of Pääsuke

Specification draft

There are two ways to integrate with Pääsuke:

  1. integrator keeps mandates on their side and Pääsuke queries X-Road services offered to Pääsuke by the integrator
  2. integrator keeps mandates in Pääsuke and the integrator queries X-Road services offered by Pääsuke.

X-Road services offered to Pääsuke

Systems that keep mandates on their side and open API to Pääsuke to query and change them

X-road services spec:

  • The latest version is 1.0.5 - 13 August 2024

OpenAPI definitions:

Sample provider application

  • Sample provider application built in Python—https://github.com/e-gov/PH-sample-provider-python (based on 1.0.0)
  • You can run it locally using Docker-compose
  • The provider stores mandates and persons in a Postgres database
  • The application keeps state—so if you add a mandate, then you can get it back

X-Road services offered by Pääsuke

Specification of the X-road services

The following specification is for systems that keep mandates in Pääsuke and load them from there using X-Road queries.

  • The latest version is 0.5.3 - 26 February 2024

OpenAPI definitions: https://app.swaggerhub.com/apis/TUGI/paasuke-oraakliliides/

X-road services in different X-road environments

The services are made available through x-road.

You need to fill in an application to get access to the services. The application formula can be found: https://www.ria.ee/riigi-infosusteem/kesksed-platvormid-avalike-e-teenuste-pakkumiseks/paasuke (chapter "Taotlused ja tingimused")

Please note that the endpoint is connected to the development environment which might be unstable.