DNK Rest API Help Page

DNK Rest Api Documentation

General

This interface has been developed for data exchange between the Sustainability Code (SC) database and external applications (import into the database as well as export).

Currently, content is maintained and exported in German and English.

Base URL

https://api.deutscher-nachhaltigkeitskodex.de

Methodology

All data are exchanged according to the same scheme:

HTTP-Methode: POST
Content-Type: application/json;charset=utf-8
dataType: json

Security

Each external application must be enabled explicitly for the data exchange with the interface. The rights for import and exprt are independent of each other and must be applied for individually.
To prevent unauthorized users from using the interface, a "security token" is required for each request to the interface.
You will receive further information about the generation of "security tokens" as soon as your application is enabled.

Values

Data controller which handles REST-Requests

API	Description
POST json/DNKDataImportFull	Imports a complete Sustainability Code record.
POST json/DNKDataImportFullArray	Imports a complete Sustainability Code record list.
POST json/ExportWithMasterData	Exports all released Sustainability Code profiles of one language and one year. Only published Sustainability Code profiles with an export authorization of the respective company will be exported. Also includes additional company data like address data or email.
POST json/DNKDataExportFullArray	Exports all released Sustainability Code profiles of one language and one year. Only published Sustainability Code profiles with an export authorization of the respective company will be exported.
POST json/DNKDataExportSingleCompanyArray	Exports one specific Sustainability Code profile of one language and one year.
POST json/DNKDataExportCompanyIdMappingArray	Exports all released Sustainability company names und IDs
POST json/DNKValidatePropertyName?nameImportProperty={nameImportProperty}	Checks the names of objects used by JSON on the client side for existence.
POST json/DNKValidateImport	Validates an import set for completeness, token, and security logic
POST json/DNKValidateImportArray	Validates a DNKImportDataList for completeness, token, and security logic