Report-API

The Report API can be used to generate and retrieve Europace reports.

Documentation

The latest OpenApi specification in json format is available at any time at https://report.api.europace.de/documentation. can be downloaded.

API use cases

• use Europace reports in dataware house ETL jobs
• provide Europace reports in sales tools

Overview Europace Reports

The following reports can be called with this API:

Name	Endpoint	Required Scope	File Type/Encoding	Content Description.
Vertriebs-Rohdaten-Report	/rohdaten	report:rohdaten:lesen	zip/UTF-8	all relevant data of Vorgänge, Anträge, Bausteine and Provisionen of the advisor Data older than 2014 will not be delivered.
Produktanbieter-Report	/produktanbieter	report:produktanbieter:lesen	csv/UTF-8	the essential data of Anträge with state and Vertriebsorganisation
Vertriebsreport	/vertrieb	report:rohdaten:lesen	csv/UTF-8	the "EUROPACE Report Vertrieb".
Smart Facts Vertrieb	/smartfactsvertrieb	report:rohdaten:lesen	XLSM	the “EUROPACE Report Vertrieb” with a graphical interface
Smart Facts Produktanbieter	/smartfactsproduktanbieter	report:produktanbieter:lesen	XLSM	the “EUROPACE Report Produktanbieter” with a graphical interface

Quickstart

The report creation is asynchronous to avoid network timeouts during the report creation. Active testing is required for the completion of the report.

The procedure is the same for all Europace reports:

1. request report
2. query report status
3. retrieve report data

To help you test our APIs and your use case as quickly as possible, we've put together a Postman Collection for you to easily follow along.

The previous day's data will be available around 5:00 am.

Example: Requesting a raw sales data report

Authentication

Please use to get access to the report API.

Which scope you need for which report you can see in the Overview Europace-Reports.

⚠️ Note . The report for the identity of the OAuth token is always supplied. To retrieve a report for another person/organisation, impersonated or another client should be used if necessary. For the Produktanbieter-Report, the Produktanbieter must be authenticated as the client.

1. request report

With the request, the generation of the report is started at Europace. This process can take several minutes depending on the complexity and the requested time period. The valid parameters for the report creation can be found in the corresponding report description.

Request for Vertriebs-Rohdaten-Report:

curl --location --request POST 'https://report.api.europace.de/rohdaten' \
--header 'X-Trace-Id: ' \
--header 'Authorization: Bearer {access-token}' \
--data-raw '{
    "fromDay": "2020-01-01"
}'

Response:

Header:
  - Status: 202 ACCEPTED
  - Location: /rohdaten/{report-processing-id}

The header variable Location points to the endpoint for the next step: to query the report status.

2. query report status

This step is the same for all Europace reports.

Request:

curl --location --request GET 'https://report.api.europace.de/rohdaten/{report-processing-id}' \
--header 'X-Trace-Id: ' \
--header 'Authorization: Bearer {access-token}'

(a) Response if the report is still in progress:

Header:
  - Status: 200 OK
Body:
{
  "status": "PROCESSING"
}

Please query again in 20s (recommendation).

(b) Response if the report has been created:

Header:
  - Status: 303 SEE OTHER
  - Location: https://{path-to-file}

The header variable 'Location' points to the report data.

3. retrieve report-data

This step is the same for all Europace reports.

The URL pointing to the result data is only valid for a limited period of time. Anyone who has this URL can access the report.

Example for {path-to-file}:

https://greta-462912489437-eu-central-1.s3.amazonaws.com/prod/{reporttyp}/{report-processing-id}/Ep2_Reports_....zip?X-Amz-Security-Token=...&X-Amz-Signature=...

Request:

curl --location --request GET 'https://greta-462912489437-eu-central-1.s3.amazonaws.com/prod/{reporttyp}/{report-processing-id}/Ep2_Reports_....zip?X-Amz-Security-Token=...&X-Amz-Signature=...

Response:

Header:
  - Status: 200 OK
Body:
<File>

The file type of <file> is described in the Overview Europace Reports. To facilitate opening with Excel, the encoding is UTF-8 with Byte Order Mark (BOM).

Terms of use

The APIs are made available under the following Terms of Use.

Support

If you have any questions or problems, pls contact [email protected].