Via the OData Reporting API, d.vinci can exchange data on applications and job openings with external systems, for example to create extensive reportings in BI tools.

In order to use the reporting API, the external system that wants to exchange data with d.vinci requires an API user with the right to use the reporting API.


Read the article Display Contents of OData Reporting API for an explanation of how to learn the API's technical contents.

Proceed as follows:

  1. Create role:
    • In the Name field you can enter, for example, "Reporting API".
    • In the User Role field, select the option No. This removes the need to specify a security level.
    • In the Product field, select the option d.vinci Applicant Tracking.
    • In the Permission field, select the option OData Reporting Data | fetch
  2. Create API User:
    • Create an API user for each external system that is to be connected to d.vinci.
    • In the Username field, you can, for example, enter the name of the external system that wants to access d.vinci's data.
    • In the Organizational Unit field, select the option Global.
    • In the fields Title, First Name, Last Name, and Email Address, you can, for example, enter the personal data of a person responsible for the external system. This can be a person in your company, or the contact person in the company of the external system. (These fields have no relevant function in this case, but can serve as contact data in case of connection problems of the external system).
    • In the Role field, select the reporting API role that you have created in the step before.
    • After creating the user, an API-Token is generated. Note the API user's username and API token, you will need them in the next step for connecting the external system to d.vinci.

After creating the API user for the external system, you can connect the two systems. On d.vinci's side, proceed as follows:

  1. Open the page Reports.
  2. Press the   icon to display more actions. Then, press  Use Reporting API . The modal window with the same name is displayed.
  3. In the modal window, the OData Source of you d.vinci system is displayed. Note the URL.

You now have all required data:

  • The URL of the OData source.
  • The username of the API user.
  • The API token.

With this data, you can connect d.vinci to the external system.

Example: Microsoft Excel 365

  1. Open a new workbook in Microsoft Excel 365.
  2. Activate the Data tab.
  3. In the Get & Transform Data group, press Get Data, then From Other Sources, an then select the option From OData Feed. The OData Feed dialog window is displayed.
  4. In the dialog window, enter the URL of the OData source, that you noted before.
  5. Press Ok. The dialog window Access an OData feed is displayed with a side menu bar.
  6. In the side menu bar, press Basic and enter the noted API user's Username and the noted API token as Password.
  7. Press Connect. Afterwards the reporting data is fetched from d.vinci and displayed as tables. You can use this data to create reports in Excel.