d.velop documents

Getting an API key

1. In d.velop cloud open Konfiguration → API-Schlüssel (or, on premises, the identityprovider app) and create an API key for a technical user.
2. Give that user read rights on the repositories the agent should reach. d.velop applies its permission model per document, so a restricted user quietly sees a smaller repository.
3. Set DVELOP_URL to your tenant root — https://<tenant>.d-velop.cloud for cloud, or your own host on premises — and DVELOP_API_KEY to the key.

The Authorization header is Bearer <apikey>, with the API key used directly as the bearer token. d.velop's API keys are long-lived; rotate them the way you would rotate a password.

Repository ids come first. d.velop can host several repositories in one tenant and every document operation is scoped to one. Call d_velop_list_repositories and keep the id — it is an opaque string, not a number.

Responses are HAL JSON. d_velop_list_repositories returns repositories[] (id, name); a search returns items[], each with id, sourceProperties and sourceCategories, plus _links.next.href for the next page. page starts at 1 and pageSize defaults to 25.

Every search and document read needs a source id. d.velop maps its internal properties to a source, and the search (/srm) and document (/o2m) endpoints return property values only through that mapping: sourceid is required. Call d_velop_list_categories first: it returns the repository's default source with its id (normally /dms/r/<repositoryId>/source), its category keys and its property keys. Use that id as sourceid, the category keys in sourcecategories and the property keys in sourceproperties.

Not run against a live tenant. The paths and parameters follow d.velop's DMSApp OpenAPI specification (help.d-velop.de/dev/documentation/dms-app); d.velop does not offer a public sandbox. If you run this against a real system, a correction to the adapter JSON is genuinely welcome.

Read-only by design: no upload, no property change. A DMS is the audit trail, and an agent should not be able to edit it by accident.