Open Documentation Menu

Activating the API for on-premises

You can install the export API (on-premises) in existing d.velop documents systems at a later point in time using the tool setup. This applies to all software versions of d.3 server from 7.2.2 onward. This standalone application provides a REST-capable web server that makes the export interface and the file download interface available.

Note

As of d.3 server version 8.37.0, the export API can also be accessed via dmsdocs.exe as standard. A separate installation is thus not required.

In this case, you enter the parameter ENABLE_EXPORTS = "1" in the file addon.ini. You also configure a user with export permissions.

Note

For the migration of d.3 server version 7: Before the data export, use UpdateChecker to check whether the system can be migrated.

This is how it works

  1. Start the application via Windows command prompt (cmd) as follows:

    d.velop_documents_repo_export_API.exe -c <drive name>:\<path to d3config> -u <exportUser> -p <Port (Default: 8333)>

    You can access the export API under the following URL:

    http://<local IP>:<Port>/repoexport/export

  2. Ensure that the user you are using exists and, depending on the version, has administrative permissions or permissions for exporting data.

  3. Use this user for every request to the export API with basic authentication. Alternatively, you can use the API key of an authorized user if you are using the dmsdocs app for the export.

/dmsdocs