Starter Guide

TecDoc Web Service

Author Liebsch, Sebastian

Version 1.9
Datum 09.11.2018
Status Public

Copyright © TecAlliance GmbH – The forwarding of this document or TecAlliance GmbH

Any excerpt from it in any form requires the written permission of TecAlliance GmbH. Steinheilstraße 10
85737 Ismaning
Germany
Tel: +49 (0)89 321216 – 0
Starter Guide – TecDoc Web Service
1.9, Public, 09.11.2018

Change History

Source- Target- Date Name Comment

Version Version
1.8 1.9 09.11.2018 Liebsch, Sebastian Minor adjustments

1.7 1.8 09.10.2018 Liebsch, Sebastian Added Application Logic (Point 3.1.2 + 3.2.3)

1.6 1.7 06.08.2018 Liebsch, Sebastian Added getAutoCompleteSuggestions (Point 5.1)

1.5 1.6 20.07.2018 Liebsch, Sebastian Added VRM look-up ES (Point 4)

1.4 1.5 03.07.2018 Liebsch, Sebastian Added Authentication Scenarios (Point 3)

1.3 1.4 22.06.2018 Liebsch, Sebastian Updated Point 6

1.2 1.3 19.06.2018 Liebsch, Sebastian Consolidated Point 5 and Point 6

1.1 1.2 01.06.2018 Liebsch, Sebastian Minor corrections and improvements

1.0 1.1 25.05.2018 Liebsch, Sebastian Minor corrections and improvements

1.0 1.0 22.05.2018 Liebsch, Sebastian Initial creation

Distribution

Role/Roles Name Phone E-Mail

Technical Analyst Liebsch, Sebastian +49 89 321216 8077 [email protected]

© TecAlliance GmbH Page 2 von 13

Starter Guide – TecDoc Web Service
1.9, Public, 09.11.2018

Table of Contents
1 TecDoc Web Service Documentation and Endpoints/WSDLs ................................ 6

2 TecDoc Web Service Documentation ................................................................... 7

2.1 Home ................................................................................................................. 7

2.2 Service Overview ............................................................................................... 7
2.3 Service Index ...................................................................................................... 7
2.4 Examples ............................................................................................................ 7
2.5 Test Client .......................................................................................................... 7

3 Authentication scenarios ..................................................................................... 8

3.1 API Key Authentication (server-side authentication) ........................................ 8

3.1.1 Article data / document handling ...................................................... 8
3.1.2 Application logic ................................................................................. 8
3.2 IP-Address / IP-Range Whitelisting (client-side authentication)........................ 9
3.2.1 Article data / document handling ...................................................... 9
3.2.2 Handling dynamic client IPs ............................................................... 9
3.2.3 Application logic ................................................................................. 9

4 Vehicle Identification ..........................................................................................10

5 Get all available article data ................................................................................11

5.1 get search query suggestions for getArticles ................................................... 12

6 Available brands for your test account................................................................12

7 TecDoc Web Service in combination with other TecAlliance solutions ................12

7.1 ServiceVT: TecDoc TypeId into RMI TypeId ..................................................... 12

© TecAlliance GmbH Page 3 von 13

Starter Guide – TecDoc Web Service
1.9, Public, 09.11.2018

7.2 ServiceVT: RMI TypeId into TecDoc TypeId ..................................................... 12

7.3 Various (Example): TecDoc GenArt into RMI ItemMpId .................................. 12
7.4 Various (Example): RMI ItemMpId into TecDoc GenArt .................................. 12
7.5 Various (Example): Use TecDoc GenArt as filter to get RMI ItemMpId ........... 13

8 Glossary ..............................................................................................................13

© TecAlliance GmbH Page 4 von 13

Starter Guide – TecDoc Web Service
1.9, Public, 09.11.2018

Starter Guide

Description
This document gives you an overview about the TecDoc Web Service (also known as TecDoc Pegasus) and its online
documentation.

Notes

© TecAlliance GmbH Page 5 von 13

Starter Guide – TecDoc Web Service
1.9, Public, 09.11.2018

1 TecDoc Web Service Documentation and Endpoints/WSDLs

Access it via https://webservice.tecalliance.services/ - listed on this site are the most used TecDoc Web Service URLs;
you’ll get additional Endpoints/WSDLs from the online documentation (Doc Site):

• Home -> important URLs

Available Endpoints/WSDLs:
• SOAP (Document Literal Bare, Document Literal Wrapped)
• JSON (Document Literal Bare, Document Literal Wrapped)

© TecAlliance GmbH Page 6 von 13

Starter Guide – TecDoc Web Service
1.9, Public, 09.11.2018

2 TecDoc Web Service Documentation

2.1 Home
Here you get a summary about the product itself and it also lists important links, please see the listing below – you should
have a look at those at least once:

• Functions Guide:
Provides you the sequence of calls of TecDoc Web Service

• Example implementation:
Interactive implementation of the sequence of calls provided in the Functions Guide

• Useful information:
Provides various data, for example Key Table values, which are needed for various TecDoc Web Service functions

2.2 Service Overview

Here you get a summary about the available protocols / formats of the TecDoc Web Services. Currently we offer SOAP
and JSON.

2.3 Service Index

Detailed information about the Web Services’ functions:
• Function description
• Request Parameters
• Response Parameters

2.4 Examples
Code Examples for JSON and SOAP:
• Basic Calls
• Simple Arrays
• Complex Arrays

Available in:
• C#
• JAVA
• JavaScript
• PHP

2.5 Test Client

Send requests directly via the browser to the TecDoc Web Service.

© TecAlliance GmbH Page 7 von 13

Starter Guide – TecDoc Web Service
1.9, Public, 09.11.2018

3 Authentication scenarios
The TecDoc Pegasus Web Services requires a ProviderId (parameter provider in the requests) for a successful
authentication on the TecAlliance systems. Additionally, there are two possibilities to restrict access for end users: Either
by IP-Address/IP-Range whitelisting (currently only for IPv4) or API Key authentication.

First time you get your ProviderId API Key Authentication is set as default. However, if IP Whitelisting Authentication is
preferred, please send the static IP address(es) of your application host(s) to your TecAlliance technical contact.

3.1 API Key Authentication (server-side authentication)

3.1.1 Article data / document handling
Article / document data needs to be delivered to the end user by your proxy server. The proxy requests the TecDoc
Pegasus API and authenticates by the API Key specified in the end point URL, for example:

https://webservice.tecalliance.services/pegasus-3-
0/services/TecdocToCatDLW.soapEndpoint?api_key=YOUR_API_KEY_HERE

Example for passing over the API Key in the HTTP header:

curl -H 'X-Api-Key: YOUR_API_KEY_HERE' 'https://webservice.tecalliance.services/pegasus-3-

0/services/TecdocToCatDLW.soapEndpoint'

Example for passing over the API Key by HTTP Basic Authentication:

curl 'https://[email protected]/pegasus-3-
0/services/TecdocToCatDLW.soapEndpoint'

The function addDynamicAddress isn't needed at all. Also, no static/dynamic IP-Addresses need to be whitelisted.

3.1.2 Application logic

© TecAlliance GmbH Page 8 von 13

Starter Guide – TecDoc Web Service
1.9, Public, 09.11.2018

3.2 IP-Address / IP-Range Whitelisting (client-side authentication)

3.2.1 Article data / document handling

A document Id is responded by functions like GetDirectArticlesByIds7 (docId) or GetVehicleByIds4 (vehicleDocId). Those
could be displayed in your application by passing over the vehicleDocId into the URL schema mentioned below.
docId has the additional identifiers docFileName, docFileTypeName, docTypeId, docTypeName, docURL.

Large Pictures:
• https://webservice.tecalliance.services/pegasus-3-0/documents/<PROVIDERID>/<DOCUMENTID>/0

Thumbnail Pictures:
• https://webservice.tecalliance.services/pegasus-3-0/documents/<PROVIDERID>/<DOCUMENTID>/1

3.2.2 Handling dynamic client IPs

In order to provide your end users access to documents/images you need to temporarily authorize their dynamic IP
addresses for your ProviderId. This is done by calling function addDynamicAddress on your application host. It’s
recommended to limit dynamic IP authorization to a maximum of 1 hour.

3.2.3 Application logic

© TecAlliance GmbH Page 9 von 13

 Starter Guide – TecDoc Web Service
1.9, Public, 09.11.2018

4 Vehicle Identification

Country Use Case keySystemType Function Comment

All countries VIN (filter) - getVehiclesByVIN
AT National Code 6 getVehiclesByKeyNumberPlates
CH Type Permit Number 4 getVehiclesByKeyNumberPlates
DE KBA Number 20 getVehiclesByKeyNumberPlates
DK (Autig.dk members) VRM 55 getVehiclesByKeyNumberPlates Add. credentials required
DK (all the others) VRM 92 getVehiclesByKeyNumberPlates Add. credentials required
ES VRM 99 getVehiclesByKeyNumberPlates Add. credentials required
FI VRM 95 getVehiclesByKeyNumberPlates Add. credentials required
FR Type Mine Number 2 getVehiclesByKeyNumberPlates
FR Type Mine Number 21 getVehiclesByKeyNumberPlates
FR VRM 50 getVehiclesByKeyNumberPlates Add. credentials required
GB VRM 99 getVehiclesByKeyNumberPlates Add. credentials required
IE VRM 99 getVehiclesByKeyNumberPlates Add. credentials required
IT VRM 50 getVehiclesByKeyNumberPlates Add. credentials required
MT VRM 99 getVehiclesByKeyNumberPlates Add. credentials required
NL VRM 1 getVehiclesByKeyNumberPlates
NO VRM 95 getVehiclesByKeyNumberPlates Add. credentials required
PT VRM 50 getVehiclesByKeyNumberPlates Add. credentials required
SE VRM 95 getVehiclesByKeyNumberPlates Add. credentials required

© TecAlliance GmbH Page 10 von 13

Starter Guide – TecDoc Web Service
1.9, Public, 09.11.2018

5 Get all available article data

To get all article data of the TecDoc database (optional filtering possible) use function getArticles, below a documentation
of all possible request parameters:

➔ returns document URLs instead of documentIds:

https://digital-assets.tecalliance.services/images/50/11c9534e207aa0a56f1158bf1a0a40e46a3f738a.jpg

© TecAlliance GmbH Page 11 von 13

Starter Guide – TecDoc Web Service
1.9, Public, 09.11.2018

5.1 get search query suggestions for getArticles

To get search query strings as input for getArticles <searchQuery> (to be used with <searchType> set to 99) you can use
function getAutoCompleteSuggestions. It returns article and vehicle manufacturer descriptions as well as assembly
groups that match your requested string.

6 Available brands for your test account

BrandId Brand
72 HERTH+BUSS ELPARTS
94 METZGER
101 FEBI BILSTEIN
268 JP GROUP
4346 VIKA
4533 ACEMARK
4938 FAST
4944 OREX

7 TecDoc Web Service in combination with other TecAlliance solutions

In case you licensed the RMI Web Service and you want to work with data that you got from TecDoc Web Service within
the RMI Web Services you simply have to do a translation via one of these RMI Web Service-methods:

7.1 ServiceVT: TecDoc TypeId into RMI TypeId

7.2 ServiceVT: RMI TypeId into TecDoc TypeId

7.3 Various (Example): TecDoc GenArt into RMI ItemMpId

7.4 Various (Example): RMI ItemMpId into TecDoc GenArt

© TecAlliance GmbH Page 12 von 13

Starter Guide – TecDoc Web Service
1.9, Public, 09.11.2018

7.5 Various (Example): Use TecDoc GenArt as filter to get RMI ItemMpId

8 Glossary

Term Explanation
TecDoc GenArt, GenArt (Generic Article): Description of a „Product / Spare Part Group“, e. g. „Brake Disc“.
GenCritNo/Value In combination with GenCrit (Generic Criteria Number and Value), e. g. „left, front“ you get the
same information as provided by the ItemMpId (Item Mount Position)
TecDoc Web Service Independent automotive aftermarket article data; also provides Vehicle register mark look-up
and vehicle identification number look-up
RMI ItemMpId The mount position of an item, e. g. “Brake disc, front, left”
RMI Web Service information system for repair and maintenance information
VIN Vehicle Identification Number
VRM Vehicle Registration Mark

© TecAlliance GmbH Page 13 von 13