Welcome to the Single Digital Entry Point (SDEP)

Overview:

• Introduction
• Specification
• Reference Implementation
• Production
• Test
• Development
• Unit Tests
• Integration Tests
• Performance Tests
• All Tests
• Functional Design
• Technical Design
• Process
• Foundation

Introduction

SDEP is established in accordance with EU legislation for short-term rental data exchange.

https://eur-lex.europa.eu/eli/reg/2024/1028/oj/eng

In accordance with EU legislation, SDEP enables the following:

• Ingestion of regulated areas from competent authorities (CA)
• Provision of regulated areas to short-term rental platforms (STR)
• Ingestion of rental-activity data from short-term rental platforms (STR)
• Provision of rental-activity data to competent authorities (CA) and other stakeholders
• Ingestion of flagged listings from short-term rental platforms (STR)
• Provision of flagged listings to relevant stakeholders

Note: Support for flagged listings is currently under development.

Specification

This repository contains the API specification for SDEP implementations across EU Member States.

The short-term rental component (STR) is EU-harmonized across SDEP implementations in EU Member States.

The competent authority component (CA) is provided as guidance and recommendation only and may differ between EU Member States.

Reference Implementation

This repository contains the EU reference implementation for SDEP implementations across EU Member States.

The implementation is provided as guidance only and can serve as a blueprint for national implementations.

The implementation may differ between EU Member States.

Production

The reference implementation is deployed in production (PRD) in the Netherlands as SDEP-NL.

To get started, see: PRD.

The PRD environment (https://sdep.gov.nl/api/docs):

• Enables competent authorities (CA) and short-term rental platforms (STR) in the Netherlands to exchange regulated-area and rental-activity data in accordance with EU legislation
• Includes the EU-harmonized short-term rental (STR) component
• Includes the SDEP-NL-specific competent authority (CA) component

Disclaimer (PRD): For production use in your own country, always contact your national SDEP representative regarding national deployment and operational responsibilities.

Test

To facilitate end-to-end testing with integration partners, the reference implementation is also deployed in a dedicated pre-production environment (PRE) in the Netherlands within SDEP-NL.

To get started, see: PRE.

The PRE environment (https://pre-sdep.minvro.nl/api/docs):

• Enables integration partners to test integrations with the EU-harmonized short-term rental (STR) component before connecting to production systems
• Also provides testing access to the SDEP-NL-specific competent authority (CA) component

In the PRE environment:

• Only anonymized data should be used
• A daily cleanup takes place to remove any residual test or production-like data

Disclaimer (PRE): For end-to-end testing in your own country, always contact your national SDEP representative for guidance on deployment, integrations, and operations.

Development

The reference implementation can also be run fullstack on a local workstation.

Tested on Linux; for Windows, consider using WSL.

Prerequisites

Required:

• Docker
• "jq" and "yq"
• "make"

Optional:

• DBGate (a PostgreSQL management tool)
• "uvx" (a component used in performance testing)

Clone this repo

To your local workstation.

Run SDEP (fullstack)

Incl. local infra (postgres + keycloak + backend):

make up

Ports for the started services are defined in .env. To override any of these values, define them in .env.extra.

Explore API docs (Swagger UI):

• http://localhost:8000/api/docs

Select client credentials (by roles):

• Choose id, secret from machine-clients.yaml

Authorize in Swagger UI:

• Select Authorize
• Enter client credentials
• Select Authorize again
• Swagger will obtain a JWT bearer token "under the hood" (acting on the token/ endpoint)
• You are authorized by roles

Explore endpoints in your current role (ca, str).

Run SDEP (backend only)

Excl. local infra:

cd backend
make up

Explore all options

make

Unit Tests

Backend only:

cd backend
make test

Integration Tests

Fullstack:

make up
make test-full
make test-malware

The tests cover the cases as described in the integration test documentation.

• Tests are executed against the complete Dockerized stack
• Test suites run sequentially: test-security, test-str, test-ca, and test-malware - each exercising the live API via curl
• Test data uses the sdep-test-* naming convention; this data is automatically detected and removed after each test run (postgres/clean-testrun.sql)
• Test isolation is enforced by comparing table row counts before and after execution (PRE/POST); any discrepancy causes the build to fail
• A consolidated summary report presents per-suite and overall totals (executed/passed/failed) and exits with a non-zero status if any test fails

The tests can also be re-used/run against real deployments (TST, ACC, PRE, PRD; contact SDEP NL for more info).

Performance Tests

Locust-based load testing for the bulk activity endpoint (POST /str/activities/bulk).

Fullstack:

make up
make test-perf

For full configuration options and usage examples, see Performance Tests.

All Tests

make up
make test

Functional Design

• Architecture
• Listing and Activity (work in progress)

Technical Design

• Architecture
• Internal Data Model
• API
• Security
• Database Dialects
• Development

Process

• Way Of Working

Foundation

This repository builds upon the original foundational work provided by the Short-Term Rental Application Profile and Prototype (STR-AP) project:

https://github.com/SEMICeu/STR-AP