API for integrators

The VDMSync public API (/v1) and webhooks: API keys with scopes and limits, agents, locations, withdrawals and stock, exports of big data sets.

Download the OpenAPI specification (JSON)

Power BI

A ready Power Query template: one query that pulls every list and report (with paging and date ranges sliced into 92-day requests) and gives tables for the model.

Download the template (vdmsync-powerbi.pq)

1. In the console (Integrations › API keys) create a key with the read scopes: network, agents, reports, supplypoint, limits, forecasts.
2. Power BI Desktop: Get data › Blank query › Advanced editor; paste the file.
3. Fill in ApiUrl, ApiKey and the date range (DateFrom, DateTo), or create parameters with those names and delete the lines.
4. When asked for credentials choose “Anonymous” (the key travels in the header) and the “Organizational” privacy level.
5. The query returns a record of tables: click a table and choose “Add as new query” for each one you need.

Refresh in the Power BI service works (static data source). Key limits: 120 requests/min, 10,000/day: spread wide date ranges over several refreshes or use the exports.