Skip to content

GET_STARTED_PRE.md

Latest commit

 

History

History
128 lines (81 loc) · 5.2 KB

GET_STARTED_PRE.md

File metadata and controls

128 lines (81 loc) · 5.2 KB
Raw

SDEP-NL - pre-production

Welcome to the SDEP-NL Pre-Production (PRE) environment. As an integration partner testing SDEP, you can use this environment:

  • To validate your integration before moving to SDEP-NL production
  • To pre-validate your integration against the harmonized short-term rental API, before moving to the SDEP in your country

Disclaimer: For end-to-end testing per country, always contact your national SDEP representative for guidance on deployment, integrations, and operations.

Table of contents

Introduction

SDEP

The Single Digital Entry Point (SDEP) is established in accordance with EU legislation for short-term rental data exchange.

The SDEP repository contains:

  • The EU-harmonized API specification for short-term rental platforms (STR)
  • The NL-specific API specification for competent authorities (CA) and statistics authorities (STA)
  • The NL-specific reference implementation

The reference implementation is deployed in the SDEP-NL Pre-Production (PRE) environment, enabling integration partners to perform end-to-end testing before moving to production, or before moving to their own national implementation.

https://pre-sdep.minvro.nl/api/docs

The NL-specific API specification and reference implementation can also serve as a blueprint for other national deployments.

In PRE, only anonymized data should be used; a daily cleanup removes any residual test data.

Authentication

SDEP is an API-first application designed for machine-to-machine (M2M) integrations.

For machine authentication, SDEP supports OAuth 2.0 with the Client Credentials Grant.

The Client Credentials Grant itself supports two client authentication methods, both on the same /token endpoint:

  • Client ID & Secret
  • Client-Signed JWT

SDEP-NL PRE supports both authentication methods.

  • Client ID & Secret
    • This is the default.
    • No additional setup is required on your side.
    • It allows you to easily authenticate and use the Swagger UI with a client ID and client secret.
    • It is used for testing purposes only.
  • Client-Signed JWT
    • This is the most secure option.
    • It requires you to setup a private/public key pair upfront, and submit the public key to team SDEP-NL.
    • It still allows you to authenticate and use the Swagger UI (after you programmatically acquired a Bearer token).
    • It is used to test (simulate) the behaviour in the production environment.
    • See Client-signed JWT authentication for guidance.

Contrary to PRE, the SDEP-NL production environment (PRD) only supports client-signed JWT authentication: see Getting started in PRD.

National SDEP implementations are free to adopt either authentication method; this does not impact the API.

To explore both authentication methods locally, see Fullstack.

Get access

Take the following steps to get access to the SDEP-NL pre-production (PRE) environment.

Generate keypair

See Client-signed JWT authentication for guidance.

Contact team SDEP-NL

Inquire contact details for team SDEP-NL (email address) at https://pre-sdep.minvro.nl/api/docs.

Send an email to SDEP-NL containing the following contact details for your technical representative:

  • Technical representative’s email address: used for onboarding and operational communication.
  • Technical representative’s phone number: used for onboarding and operational communication.

Also include in the email:

  • Your public key: used to authenticate your client through client-signed JWT
  • Your role: used to grant the appropriate API permissions
    • Competent authority (CA)
    • Short-term rental platform (STR)
    • Statistics authority (STA)
    • Listing screening authority (LSA)
    • Listing monitoring authority (LMA)
    • Activity monitoring authority (AMA)

Receive connection info

From team SDEP-NL, you will receive connection info for both authentication methods:

  • Client ID & secret: to support client-secret authentication
  • Token request values: to support client-signed JWT

One client per organization: each competent authority (CA) and each short-term rental platform (STR) gets exactly one client.

  • All your systems use that one client, and share its credentials.
  • A second client is not linked to your organization: SDEP treats it as a separate CA or platform, with its own ID and its own data.

See Client-signed JWT authentication for applying these to the SDEP API.

Ask questions

If you have any questions, feel free to reach out at the above contact details.

Best regards, Team SDEP-NL