B2B Partner Guidance Remote Diagnostic Support - Xentry-Shop
←
→
Page content transcription
If your browser does not render page correctly, please read the page content below
2 Mercedes-Benz AG | B2B Partner Guidance Contact Mercedes-Benz Customer Assistance Center Connected Mobility Services – Remote Diagnostics Support Email: extended-vehicle.emea@cac.mercedes-benz.com Mercedes-Benz AG Stuttgart, Germany www.mercedes-benz.com Copyright © Mercedes-Benz AG. All Rights Reserved. The text, images, graphics, sound files, animation files, video files and their arrangement on Mercedes-Benz Internet sites are all subject to Copyright and other intellectual property protection. These objects may not be copied for commercial use or distribution, nor may these objects be modified or reposted to other web sites, apps or other digital content (hereinafter “Digital Offerings”). Some Mercedes-Benz Digital Offerings also contain material that is subject to the copyright rights of their providers.
Mercedes-Benz AG | B2B Partner Guidance 3 Table of Contents Table of Contents 3 1 Introduction 4 1.1 Overview – Remote Diagnostic Support 4 1.2 Frequently Used Terms 4 2 What is the Remote Diagnostic Support Offering? 6 3 How to use Remote Diagnostic Support? 9 3.1 Registration Process 10 3.2 Purchasing RDS 20 3.3 Data retrieval 32 3.4 Prerequisites 33 4 Support 35 5 FAQs 36 6 Appendix 40
4 Mercedes-Benz AG | B2B Partner Guidance 1 Introduction This document serves as comprehensive product description of Remote Diagnostic Support (RDS). In addition to a detailed description of the RDS product itself, it contains a step-by-step instruction on how RDS can be purchased and a list of all prerequisites that need to be met prior to the purchase. Besides, a collection of frequently asked questions (FAQs) and information on where to find support is provided. The following two subchapters aim at providing a brief overview of RDS and introduce the most frequently used terms. 1.1 Overview – Remote Diagnostic Support With Remote Diagnostic Support (RDS) the Mercedes-Benz AG and the Daimler Truck AG provide authorized Business-to-Business (B2B) partners in accordance with the European Type Approval Framework (Nr. 715/2007 und Nr. 692/2008) vehicle-generated diagnostics data use cases based on ISO standards ISO/DIS 20078 and ISO/DIS 20080. While on-board diagnostics (OBD) already offers access to certain diagnostics data, but requires the vehicle to be on-site, RDS allows remote access. By purchasing the RDS product, you will currently gain remote access to up to six diagnostics data use cases described in ISO/DIS 20080 per provided vehicle identification number (VIN) – given that end customer consent (approval) has been provided. In addition to the diagnostic data use cases described in the ISO/DIS 20080 standard, the RDS product contains the functionality to request a new vehicle data set via telediagnostics (for more information on the product scope, see Chapter 2). Initially you need to register on Mercedes-Benz /developers and add an application, which is required to access the data via an application programming interface (API) prior to the actual purchase. If you are interested in a purchase, you need to register on XENTRY Shop and be classified as an authorized user since RDS is only available for independent operators as specified in the European Type Approval Framework (No. 715/2007 and No. 692/2008 respectively). After a successful registration you can purchase RDS via the XENTRY Shop. For RDS diagnostics data to be available different requirements need to be fulfilled, e.g. the activation of Mercedes-Benz connectivity services (e.g. Mercedes me connect, Mercedes PRO, Mercedes-Benz Uptime, OMNIplus Uptime) and the provision of end customer consent (approval). For further information on the prerequisites, please see chapter 3.4. 1.2 Frequently Used Terms App-ID / Project-ID A 32-digit code that serves as an identifier for an application created on Mercedes-Benz /developers. It is provided after the completion of the application registration process on Mercedes-Benz /developers and must be entered during the purchase process of RDS on the XENTRY Shop website. The process illustrations may show the App-ID still, however this is now the Project-ID. Application Programming Interface (API) Set of definitions, programming instructions, communication protocols and tools that allow one program to interface with another one. Mercedes-Benz AG provides usage rights to its API products on Mercedes–Benz /developers, thus enabling an integration of an API into the third parties’ proprietary software or innovative applications as well as the use of the associated contents. Diagnostic Trouble Code (DTC) A code that identifies malfunctions that can occur during the operation of a vehicle. Each code corresponds to a fault detected in the vehicle. Codes are stored in the fault memories of the electronic control units (ECUs) installed in the vehicle and can be read out via on-board diagnostics (OBD). Electronic Control Unit (ECU) Embedded, electronic modules that control one or more of the electrical systems or subsystems in a vehicle. End customer End customer essentially means the vehicle owner. This can be a private person or a fleet operator. Independent Operator / Independent Service Provider (ISP) The term refers to the European Type Approval regulation (EC) No. 715/2007, respectively (EU) 2018/858 in the future, and subsumes companies, which are not authorized dealers or repair workshops and are directly or indirectly involved in the maintenance and repair of motor vehicles in particular repairers, manufacturers or distributors of repair equipment, tools or spare parts, publishers of technical information, automobile clubs, roadside assistance operators, operators offering inspection and testing services, operators offering training for installers, manufacturers and repairers of equipment for alternative fuel vehicles. In this document the terms “B2B partner”, “independent operator” and “third party” will be used synonymously.
Mercedes-Benz AG | B2B Partner Guidance 5 Malfunction Indicators Warning and event/indicator messages of the electronic instrument cluster for passenger cars and vans. Mercedes-Benz /developers Mercedes–Benz /developers is the public API platform provided by Mercedes-Benz Connectivity Services GmbH. Its mission is to support developers, start-ups and established enterprises in creating innovative applications. They make their services available via APIs to spur the development of pioneering business models around mobility and beyond XENTRY Shop. Mercedes me Portal Web-based platform that brings together Mercedes-Benz offers, services and news for passenger car end customers including: usage of Mercedes me connect services, vehicle management and view of vehicle data, view of digital service report, receive individual advice and service. Mercedes PRO Mercedes-Benz van brand for all current and future services, solutions and digital services for the customers day-to-day business. It comprehensively bundles all the services of relevance to the customer on a single web-based platform. Mercedes-Benz Uptime Mercedes-Benz service powered by Fleetboard and the in-vehicle Truck Data Center that is used to analyze the entire technology of the truck based on the sensors installed in the vehicle. Fully automatic Telediagnostics continuously checks the status of the vehicle systems in real time, allowing critical conditions to be detected at an early stage and concrete instructions to be provided. If maintenance and repair requirements are identified, the Mercedes-Benz Service Partner will inform the customer in person and support him with a repair solution. OMNIplus Uptime Digital service by OMNIplus ON based on in-vehicle Bus Data Center that is used to analyze the entire technology of the bus/coach based on the sensors installed in the vehicle. Fully automatic Telediagnostics continuously checks the status of the vehicle systems in real time, allowing critical conditions to be detected at an early stage and concrete instructions to be provided. If maintenance and repair requirements are identified, the OMNIplus Service Partner will inform the customer in person and support him with a repair solution. OAuth Industry-standard protocol for authorization that is supported by Mercedes-Benz /developers APIs (OAuth 2.0). On-board diagnostics (OBD) Describes a vehicle’s self-diagnostic and reporting capability that provides access to the status of the various vehicle subsystems. Vehicle Identification Number (VIN) An intentionally standardized 17-digit code that allows for the unique identification of a vehicle. XENTRY Shop Web shop where authorized users can order XENTRY vehicle diagnostic systems, workshop equipment, and diagnostic solutions for standard PCs and media.
6 Mercedes-Benz AG | B2B Partner Guidance 2 What is the Remote Diagnostic Support Offering? Chapter two provides a detailed description of the Remote Diagnostic Support (RDS) product. Purchasing RDS allows you to access vehicle-generated diagnostics data remotely. After the end customer has provided consent (approval), generated vehicle data is transferred to and stored by the Mercedes-Benz AG. From there, you can access selected diagnostics data after purchasing RDS. At this point additional customer consent (approval) for the data transfer to third parties is required. The following illustration shows the data flow in a simplified manner. Description of the data flow process: Data flow in the vehicle: In the occurrence of an event of a control unit (CU), the telematics control unit (TCU) is informed. The TCU then collects all relevant information from all installed control units. Depending on the model series, up to five minutes must be driven. If an event, such as an actual error is detected during collection, this data is sent to the backend by the telematics control unit. A pure status change of such an error from “curren”t to “saved” would not lead to a transmission to the backend. Data flow in the backend: Once the raw data has been received, it is stored in an interpretable format and is then available for retrieval. This can take up to an hour. The RDS product includes a total of six data use cases, defined by ISO/DIS 20080, that you can retrieve and an optional function “Vehicle Data Readout Refresh”: Use cases: Use Case Discovery (Use case 01 as defined by ISO/DIS 20080) Request information about which remote diagnostic functionality is available for selected vehicle Identify Electronic Control Units (ECUs) installed in the vehicle (Use case 02 as defined by ISO/DIS 20080) Identify all IDs and corresponding software and hardware part numbers, which are installed in the chosen vehicle Read Diagnostic Trouble Codes (DTCs) (Use case 03 as defined by ISO/DIS 20080) Read all DTCs either from all ECUs in the vehicle or from one specific ECU Read DTC Snapshot Data (Use case 05 as defined by ISO/DIS 20080)
Mercedes-Benz AG | B2B Partner Guidance 7 DTC Snapshot data is a specific data record associated with a set DTC Read Malfunction Indicator Status (Use case 07 as defined by ISO/DIS 20080) Read warning- and indicator messages of the instrument cluster for passenger cars and vans Note: Under certain circumstances odometer information in the DTC snapshot data and malfunction indicators may be stored in the instrument cluster, which due to vehicle conditional reasons are smaller than the distance at time of occurrence of the event. Function: Vehicle Data Readout Refresh Optional function that can be used in case of an outdated time stamp (output by use case 01 Use Case Discovery) to retrieve the latest available data from the vehicle's data memory or to trigger a new data record retrieval in the vehicle. Prerequisite for using the function for passenger cars is the activation of the service "Remote Vehicle Diagnostics" in the Mercedes me Portal by the end customer. For Mercedes Pro and Mercedes Uptime end customers no additional service must be activated. Clear all DTCs (Use case 08 as defined by ISO/DIS 20080) Clear all Diagnostic Trouble Codes (DTCs) in the vehicle storage (Only for passenger cars available) Prerequisite to use this function for passenger cars is the activation of the service “Remote Diagnostics” in the Mercedes me Portal by the vehicle owner. For this use case certain instructions must be carried out simultaneously in the vehicle, thus a direct access to the vehicle is necessary (further details see FAQ). After a successful, “Clear all DTCs” request and following all instruction steps in the vehicle, it may require up to 15 minutes until a new quick test is available without any DTCs. During this time, an additional request of “Clear all DTCs” or “Vehicle Data Readout Refresh” should be avoided. Note: This use case responses with the http-return code “206 Partial Content”, if the last data set in the backend is older than one hour. In this case, first execute the function “Vehicle Data Readout Refresh” so that the vehicle status is protocolled before the clearance. In case the latest data set available is not older than one hour this use case responses with the http- return code “201 Created”. Only then the “Clear all DTC Jobs” request is send to the vehicle. Since this use case makes changes in the vehicle, the vehicle owner needs to be informed and confirm in your application the clearance of all DTCs of his vehicle. Advise: We recommend that you call up the use cases in the following sequence. 1. Call of use case 1 to identify all available use cases and functions 2. Decide based on the receivedTimestamp data point, if a new data set is required by using the function Vehicle Data Readout Refresh 3. Call of the required use cases 4. Optional: Clear all DTC Jobs to clear all DTCs in the vehicle memory. Therefore the latest data set in the backend cannot be older than one hour to comprise all DTCs. This is required to protocol the process. The data will be provided via an application programming interface (API). To access data, you need to develop an application and have additional software ready to process remote diagnostic data output, which is provided in machine-readable form (JSON format). Please visit Mercedes-Benz /developers to receive more detailed information. A requirement to subsequently purchase RDS is a so-called “Project-ID”. You (as B2B partner) have to register on Mercedes-Benz /developers and add your developed application in order to receive your Project-ID. The registration requires the specification of an application name and a “purpose of use” in the form of an Uniform Resource Locator (URL). Both will be visible for the end customer. Interested parties can find detailed information and requirements that are needed for the development of a suitable application on Mercedes-Benz /developers. The actual purchase of RDS takes place on the XENTRY Shop website. There are three different prepaid packages available. Each package includes a certain amount of included data retrievals. One data retrieval contains the retrieval of one data use case. Only data use cases (as defined in ISO/DIS 20080), Read Diagnostic Trouble Codes (DTCs) (UC3), Read Malfunction Indicators (UC7) and Clear all DTCs (UC8) are fee-based, meaning that only the retrieval of this particular data use cases trigger a reduction of your purchased credit balance. This also applies to the function Vehicle Data Readout Refresh. In contrast, requesting the other data use cases will have no effect on your purchased credit balance. Please note that the pricing model may change in the course of product development in the future. Further information on the price and invoicing can be found on the XENTRY Shop website. Important note: To purchase RDS via the XENTRY Shop, you need to have the status of a so-called “authorized user”. For this, a registration on the shop’s website is required (for further details please see chapter 3.2).
8 Mercedes-Benz AG | B2B Partner Guidance For further prerequisites that need to be fulfilled to establish a data transfer for the RDS product please see chapter 3.4. The RDS product can be purchased for passenger cars (i.e. Mercedes me vehicle), van (i.e. Mercedes PRO vehicles), truck (i.e. Mercedes-Benz Uptime vehicles) and busses (i.e. OMNIplus Uptime vehicles).
Mercedes-Benz AG | B2B Partner Guidance 9 3 How to use Remote Diagnostic Support? This chapter serves as detailed RDS how-to-use guide. It gives an overview about the “RDS Journey”, guides you through the registration and purchase process and introduces prerequisites for purchase and use of the RDS product. To make use of RDS certain requirements need to be fulfilled first. The following figure illustrates what needs to be considered to successfully access the Remote Diagnostic Support inherent data. Please note that the following screenshots reflect the status as of September 2019 and may change in future releases.
10 Mercedes-Benz AG | B2B Partner Guidance 3.1 Registration Process In the following, the registration process on Mercedes-Benz /developers as well as on the XENTRY Shop website is described in detail. 3.1.1 Mercedes-Benz /developers Registration Mercedes-Benz /developers is a public developer platform provided by the Mercedes-Benz Mobility GmbH. On the platform you can receive the usage rights to APIs of the Mercedes-Benz AG enabling you to integrate them in your proprietary software or innovative applications. The API for RDS can be accessed on Mercedes-Benz /developers, whereby a registration on the platform is necessary. You will be required to register and login, add your developed application and specify its name and provide a purpose of use URL. As soon as you have purchased credit, you can view your remaining credit balance here. The detailed registration process on Mercedes-Benz /developers is described below.
Mercedes-Benz AG | B2B Partner Guidance 11
12 Mercedes-Benz AG | B2B Partner Guidance 3.1.2 End customer App registration
Mercedes-Benz AG | B2B Partner Guidance 13
14 Mercedes-Benz AG | B2B Partner Guidance
Mercedes-Benz AG | B2B Partner Guidance 15
16 Mercedes-Benz AG | B2B Partner Guidance
Mercedes-Benz AG | B2B Partner Guidance 17 The OAuth 2.0 authorization framework enables your application to obtain limited access to an HTTP service, either on behalf of a resource owner by orchestrating an approval interaction between the resource owner and the HTTP service, or by allowing your application to obtain access on its own behalf. Please visit Mercedes-Benz /developers to learn more about OAuth via the following link: https://developer.mercedes-benz.com/content-page/oauth-documentation.
18 Mercedes-Benz AG | B2B Partner Guidance 3.1.3 XENTRY Shop Registration The XENTRY Shop offers a variety of products such as vehicle diagnostic systems, workshop equipment as well as diagnostic solutions for standard PCs and media, whereby products can only be purchased by so-called “authorized users” registered on the XENTRY Shop. According to the European Type Approval regulation (EC) No. 715/2007, respectively (EU) 2018/858 in the future, only certain user groups are authorized to access RDS. When you register on our UMAS (User Management After Sales) portal, which can be accessed via the XENTRY Shop website, among other places, it is checked whether you belong to the defined user group. The company data you entered (e.g. country code, company number, address, company tax identification number) will be reviewed and your user account will be created. Once you are verified as an authorized user, you can log in to the XENTRY Shop. The XENTRY Shop registration process is described below:
Mercedes-Benz AG | B2B Partner Guidance 19
20 Mercedes-Benz AG | B2B Partner Guidance 3.2 Purchasing RDS 3.2.1 Purchasing on XENTRY Shop After the successful completion of the registration process on Mercedes-Benz /developers and XENTRY Shop, you can login on XENTRY Shop with your credentials and start the purchase process to acquire credit for the retrieval of RDS data via OneAPI. You can choose between three different package sizes. Please make sure to keep your Project-ID ready, which you have received during the registration process on Mercedes-Benz /developers. Please find the detailed step-by-step instruction below.
Mercedes-Benz AG | B2B Partner Guidance 21
22 Mercedes-Benz AG | B2B Partner Guidance
Mercedes-Benz AG | B2B Partner Guidance 23
24 Mercedes-Benz AG | B2B Partner Guidance
Mercedes-Benz AG | B2B Partner Guidance 25
26 Mercedes-Benz AG | B2B Partner Guidance
Mercedes-Benz AG | B2B Partner Guidance 27 Following the successful completion of the purchase process, you will receive an order confirmation via e-mail to confirm your order number, order date, Project-ID and contact details. Furthermore, your package size, order type, quantity, unit and payment type will be summarized. After receiving the confirmation e-mail, your purchased package will be activated on Mercedes-Benz /developers. This can take up to several days. You will receive a notification as soon as the purchased balance is credited. You can check the quantity of your available retrievals at all times in your Mercedes-Benz /developers account console or directly log in on Mercedes-Benz /developers by clicking on the following link https://developer.mercedes-benz.com/console).
28 Mercedes-Benz AG | B2B Partner Guidance 3.2.2 Checking the balance The RDS data retrieval packages are paid in advance, meaning that you must pay for the selected package before the purchased number of data retrievals is credited to your balance. Below a detailed description on how to check your remaining balance on Mercedes-Benz /developers is provided:
Mercedes-Benz AG | B2B Partner Guidance 29
30 Mercedes-Benz AG | B2B Partner Guidance
Mercedes-Benz AG | B2B Partner Guidance 31
32 Mercedes-Benz AG | B2B Partner Guidance 3.3 Data retrieval For detailed instructions on how to retrieve RDS data, please go to Mercedes-Benz /developers and register if you have not already done so or click on the link.
Mercedes-Benz AG | B2B Partner Guidance 33 3.4 Prerequisites This subchapter summarizes the prerequisites that need to be fulfilled by the end customer for you to be able to access RDS data. Connectivity Services - Country Specifics Please be informed that RDS is only available for those vehicles, for which connectivity services provided by Daimler Truck AG or Mercedes-Benz AG are available. To get an overview of which connectivity services are currently available in which country please log in on Mercedes-Benz /developers and visit https://developer.mercedes-benz.com/apis/remote_diagnostics_api. Connectivity Services – Vehicle Specifics Please note that RDS is only available for a selection of Mercedes-Benz series and certain vehicles depending on the production month due to the necessity of certain communication modules to be present. To get an overview the respective vehicle models log in on Mercedes-Benz /developers and visit https://developer.mercedes-benz.com/apis/remote_diagnostics_api. Divisions As mentioned above, the customer is required to activate connectivity services and accept the terms and conditions of the corresponding portal. The services are free of charge for the customers. Further information about available connectivity services can be viewed below: For passenger car & van customers: Mercedes me Portal For van business customers: Mercedes PRO For truck customers: Mercedes-Benz Uptime For bus customers: OMNIplus Uptime VIN and end-customer consent (approval) Generally, you need to be in the possession of the vehicle identification number (VIN) of the respective customer. To be able to retrieve RDS data from your customer, you need customer consent (approval) first. The approval process is multi-layered and depends on the vehicle type and its associated customer-specific portals of Daimler Truck AG and Mercedes-Benz AG. 1. Mercedes me Customer (Passenger car and private van customers) Mercedes me Portal: The first prerequisite is that customer consent (approval) to the terms and conditions of the Mercedes me Portal must be provided. Telediagnostics: The second prerequisite is the activation of the “Telediagnostics” service on the Mercedes me Portal by the end customer to enable the data flow. Note: For the function “Vehicle Data Readout Refresh” an additional service “Remote Vehicle Diagnostics” needs to be activated in Mercedes me. Interface to Third-Party Providers: The third prerequisite is the consent (approval) of the end customer to the service “Interface to Third-Party Providers” on the Mercedes me Portal website. Mercedes-Benz branded Pop-Up Window: Finally, after the redirection from your application (third-party application) to a Mercedes-Benz branded pop-up window, the consent (approval) of the end customer is required to release the transfer of RDS diagnostics data. 2. Mercedes PRO Customer (Van business customers) Mercedes PRO Portal: In order to be able to purchase the service package “Optimized Assistance” from the Mercedes PRO Portal and activate it for one or several Mercedes PRO vehicles, the customer has to agree to the terms and conditions of the Mercedes PRO Portal – thus no additional approval is required. Mercedes-Benz branded Pop-Up Window: In order to provide customer consent (approval), Mercedes PRO Portal log in credentials are required. Please note, that customer consent (approval), in this case given by the respective fleet manager, refers exclusively to this particular fleet manager. 3. Mercedes-Benz Uptime Customer (Truck business customers) Mercedes-Benz Uptime Portal: In order to be able to conclude the service contract for Mercedes-Benz Uptime, the customer has to agree to the terms and conditions of the Mercedes-Benz Uptime Portal. Thus, additional customer consent (approval) to the Mercedes-Benz Uptime Portal terms and conditions is not required. Mercedes-Benz branded Pop-Up Window: In order to provide customer consent (approval), Mercedes me Portal log in credentials are required. Thus, the fleet manager has to create an account for the Mercedes me Portal. Doing so, it is crucial to use the e-mail address that has been used for the Mercedes-Benz Uptime registration.
34 Mercedes-Benz AG | B2B Partner Guidance 4. OMNIplus Uptime Customer (Bus business customers) OMNIplus ON Portal: The first prerequisite is that customer consent (approval) to the terms and conditions of the OMNIplus ON Portal must be provided. Telediagnostics: The second prerequisite is the activation of the “Telediagnostics” service OMNIplus Uptime in the OMNIplus ON Portal by an authorized user. Mercedes-Benz branded Pop-Up Window: Finally, after the redirection from your application (third-party application) to the OMNIplus ON Mercedes-Benz branded pop-up window, the consent (approval), in this case by the respective company administrator of the entire fleet, is required to release the transfer of RDS diagnostics data.
Mercedes-Benz AG | B2B Partner Guidance 35 4 Support For support inquires and open questions which are not covered through the FAQs in chapter 5 please contact the Mercedes-Benz Customer Assistance Center by using the following e-mail address: extended-vehicle.emea@cac.mercedes-benz.com
36 Mercedes-Benz AG | B2B Partner Guidance 5 FAQs Please note that the FAQs were last updated in March 2021. 1. Which data can be retrieved with Remote Diagnostic Support (RDS)? Use cases: Use Case Discovery (Use case 01 as defined by ISO/DIS 20080) Request information about which remote diagnostic functionality is available for selected vehicle Identify Electronic Control Units (ECUs) installed in the vehicle (Use case 02 as defined by ISO/DIS 20080) Identify all IDs and corresponding software and hardware part numbers, which are installed in the chosen vehicle Read Diagnostic Trouble Codes (DTCs) (Use case 03 as defined by ISO/DIS 20080) Read all DTCs either from all ECUs in the vehicle or from one specific ECU Read DTC Snapshot Data (Use case 05 as defined by ISO/DIS 20080) DTC Snapshot data is a specific data record associated with a set DTC Read Malfunction Indicator Status (Use case 07 as defined by ISO/DIS 20080) Read warning- and indicator messages of the instrument cluster for passenger cars and vans Note: Under certain circumstances odometer information in the DTC snapshot data and malfunction indicators may be stored in the instrument cluster, which due to vehicle conditional reasons are smaller than the distance at time of occurrence of the event. Function: Vehicle Data Readout Refresh Optional function that can be used in case of an outdated time stamp (output by use case 01 Use Case Discovery) to retrieve the latest available data from the vehicle's data memory or to trigger a new data record retrieval in the vehicle. Prerequisite for using the function for passenger cars is the activation of the service "Remote Vehicle Diagnostics" in the Mercedes me Portal by the end customer. For Mercedes Pro and Mercedes Uptime end customers no additional service must be activated. Clear all DTCs (Use case 08 as defined by ISO/DIS 20080) Clear all Diagnostic Trouble Codes (DTCs) in the vehicle storage (Only for passenger cars available) Prerequisite to use this function for passenger cars is the activation of the service “Remote Diagnostics” in the Mercedes me Portal by the vehicle owner. For this use case certain instructions must be carried out simultaneously in the vehicle, thus a direct access to the vehicle is necessary (further details see FAQ). After a successful, “Clear all DTCs” request and following all instruction steps in the vehicle, it may require up to 15 minutes until a new quick test is available without any DTCs. During this time, an additional request of “Clear all DTCs” or “Vehicle Data Readout Refresh” should be avoided. Note: This use case responses with the http-return code “206 Partial Content”, if the last data set in the backend is older than one hour. In this case, first execute the function “Vehicle Data Readout Refresh” so that the vehicle status is protocolled before the clearance. In case the latest data set available is not older than one hour this use case responses with the http- return code “201 Created”. Only then the “Clear all DTC Jobs” request is send to the vehicle. Since this use case makes changes in the vehicle, the vehicle owner needs to be informed and confirm in your application the clearance of all DTCs of his vehicle. 2. Will RDS data be pushed to the B2B partner in real time? RDS data is only provided via “pull”, not “push”- function in accordance to ISO/DIS 20078. Depending on the vehicle type and model, the vehicle-generated maintenance-relevant data, is sent cyclically or triggered by an event to the data memory of the Mercedes-Benz AG. The RDS services query the memory. The timeliness is defined by a time stamp within the data and can be retrieved free of charge via the data application case "Use Case Discovery".
Mercedes-Benz AG | B2B Partner Guidance 37 If the time stamp is outdated, the function "Vehicle Data Readout Refresh” can be used to request a new vehicle data record from the data memory. In order to use this function, the vehicle owner must activate the "Remote Vehicle Diagnostics" service in the Mercedes me Portal. 3. For whom is Remote Diagnostic Support available? According to the European Type Approval regulation (EC) No. 715/2007, respectively (EU) 2018/858 in the future, RDS is available exclusively for independent operators. The term “independent operator” refers to the definition in the European Type Approval and subsumes “…undertakings other than authorized dealers and repairers which are directly or indirectly involved in the repair and maintenance of motor vehicles, in particular repairers, manufacturers or distributors of repair equipment, tools or spare parts, publishers of technical information, automobile clubs, roadside assistance operators, operators offering inspection and testing services, operators offering training for installers, manufacturers and repairers of equipment for alternative fuel vehicles…”. The prerequisite is that independent operators are registered in the European Economic Area, including Switzerland. User groups that are not authorized for the purchase include: Private individuals Companies that are not directly or indirectly involved in maintenance and repair of vehicles Companies registered outside the European Economic Area or Switzerland 4. How can I be verified as an authorized user? According to the European Type Approval regulation (EC) No. 715/2007, respectively (EU) 2018/858 in the future, only certain user groups are authorized to access RDS. When you register on our UMAS (User Management After Sales) portal, which can be accessed via the XENTRY Shop website, among other places, it is checked whether you belong to the defined user group. The company data you entered (e.g. country code, company number, address, company tax identification number) will be reviewed and your user account will be created. Once you are verified as an authorized user, you can log in to the XENTRY store. 5. Which steps are necessary to use the programming interface for the first time? (Registration & Ordering) Several steps are required before the API can be used for the first time. This includes registration on Mercedes-Benz /developers and the registration and purchase of credit in the XENTRY Shop. For the registration process to use the XENTRY Shop, you will be automatically redirected to the (UMAS) portal. You can then log in to the XENTRY Shop afterwards again. 6. Why do I have to register on two different platforms? The data package selection and its payment are processed via the XENTRY Shop. This online shop focusses on independent operators and offers, among others, different diagnostic hard- and software products. A registration on this platform is necessary to verify whether you are authorized to purchase RDS. The API is provided via Mercedes-Benz /developers. The website offers various APIs and is primarily aimed at developers of application software. 7. What is a Project-ID and how can I get it? When purchasing credit in the XENTRY Shop, an Project-ID (32- digit code) must be entered. You will receive a Project-ID on Mercedes- Benz /developers following the registration of a new application. This step is necessary before credit can be bought. Therefore, to place an order, a Project-ID is required. 8. What is a Purpose URL and why do I have to create it? The purpose of the Purpose URL is to make it clear to the vehicle owner using the third-party application for what purpose the third-party is using its data. This is necessary because of the General Data Protection Regulation (GDPR). The page to which the URL leads is not limited to a certain number of characters; the content can be freely designed by the third-party application provider. 9. How much credit can I buy and how long is it valid? RDS available in three different package sizes with a validity of 90 days each. With purchase of any new package before expiration, the validity of the total balance is set to 90 days. To check the overview of the package sizes and prices please visit XENTRY Shop. 10. The packages offered do not fit to my individual business purpose. What can I do? In case the offered packages sizes (retrieval volumes) do not fit to your intended usage, please contact the support. 11. Where can I see my current balance? You can check your current credit by logging in on Mercedes-Benz /developers. 12. How does the data retrieval work? A detailed documentation about the usage of the API including user advice is available here. 13. Is additional hardware or software required?
38 Mercedes-Benz AG | B2B Partner Guidance To query the data, you do not need additional diagnostics hardware. As the data is provided in machine-readable form (JSON format), a corresponding software for further processing is required. This software is not provided by Mercedes-Benz AG. A precondition to interpret the partly vehicle manufacturer specific information is that the B2B partner has access to vehicle manufacturer specific information about identifiers (including vehicle identifier), parameters, units, conversions and the definition of the DTC statuses. 14. How do I know which vehicles are sending data (only relevant for passenger cars)? Data retrieval is only possible for vehicles whose connectivity services “Telediagnostics” and “Interface to Third-Party Providers” have been activated. Furthermore, explicit customer consent (approval) is required. A detailed overview of relevant vehicle models and countries as well as the currently available connectivity services are available in the product description on Mercedes-Benz /developers. For individual and precise information about the available functions of individual vehicles, data use case “Use Case Discovery" (Use case 01 “Use Case Discovery” as defined by ISO/DIS 20080) is suitable. 15. I can't access the data or receive an error code. What could be the problem? This may have several causes. To retrieve data, a valid VIN must be entered for a vehicle that uses a connectivity service including telediagnostics”. Prior to accessing data, the service “Interface to Third-Party Providers” must be activated via the Mercedes me Portal by the end customer (Mercedes-Benz Passenger Cars only). Additionally, the end customer must approve the data access request of a third-party provider individually. For further questions and to interpret the error codes, please visit Mercedes-Benz /developers or contact the support. 16. What is included in one data retrieval? One data retrieval includes the retrieval of one data use case. Only data use case number “Read Diagnostic Trouble Codes (DTCs)” (UC3), “Read Malfunction Indicator Status” (UC7) and “Clear all DTCs” (UC8) (as defined in ISO/DIS 20080), are fee-based, meaning that only the retrieval of these particular data use cases trigger a reduction of your purchased credit balance. In contrast, requesting the other data use cases will have no effect on your purchased credit balance. Please note that the pricing model may change in the course of product development in the future. Further information on the price and invoicing can be found on the XENTRY Shop website. We recommend you retrieve the data use cases in the order found below. If you retrieve all five data use cases, your credit will only be reduced by one call. The RDS product includes six data use cases, defined by ISO/DIS 20080, that you can retrieve and an optional function “Vehicle Data Readout Refresh”: Use Case Discovery (Use case 01 as defined by ISO/DIS 20080) Identify Electronic Control Units (ECUs) installed in the vehicle (Use case 02 as defined by ISO/DIS 20080) Read Diagnostic Trouble Codes (DTCs) (Use case 03 as defined by ISO/DIS 20080) Read DTC Snapshot Data (Use case 05 as defined by ISO/DIS 20080) Read Malfunction Indicator Status (Use case 07 as defined by ISO/DIS 20080) Clear All DTCs ( Use case 08 as defined by ISO/DIS 20080) Vehicle Data Readout Refresh 17. How does the end customer approve the data access? What happens if the end customer does not approve the access to his data? For the authorization process by the end customer, OAuth 2.0 (Open Authorization) is used. This open protocol allows the end customer to provide the third party with access to the customer’s data for use in a third party application. When opening the application, the end customer will be redirected to a user interface on which the customer is asked to login with his login data of the connectivity service he uses. After that, the customer will be asked to allow access to the data points requested by the third-party provider, which customer can confirm or reject. The end customer can view the purpose stated by the third-party provider. If customer consent (approval) is given, the third-party provider receives an access token allowing the retrieval of the requested data. If the end customer refuses to accept, he will receive an error code. 18. Why do I get an outdated timestamp in the dataset despite using the Vehicle Data Readout Refresh function? (In the case of passenger cars) Depending on the vehicle type and model, the vehicle-generated maintenance-relevant data, is sent cyclically or triggered by an event to the data memory of the Mercedes-Benz AG. The RDS services query the memory. The timeliness is defined by a time stamp within the data and can be retrieved free of charge via the data application case "Use Case Discovery". If the time stamp is outdated, the function "Vehicle Data Readout Refresh” can be used to request a new vehicle data record from the data memory. In order to use this function, the vehicle owner must activate the "Remote Vehicle Diagnostics" service in the Mercedes me Portal. 19. Do you use data encryption for data transfer? For safe data transmission, a SSL encryption is used. 20. Why can’t I see all ECUs available for cable bound OBD2 diagnosis?
Mercedes-Benz AG | B2B Partner Guidance 39 The reason for that is the general difference between the cable bound diagnosis and remote diagnosis. This holds for the authorized network and for independent operators alike. Physically, within Mercedes EE-Architecture, any CAN-ECU may act as a gateway to a set of LIN-ECUs. Lin-Errors during operation (e.g. a failure in the seat heating system) are sent to the CAN-Gateway and are stored there. In comparison to the more powerful CAN-ECUs, who can in parallel operate the car and can be queried for diagnostic status information, LIN-Ecus are able of just one task at a time (e.g. either operating and, in case of an error, signaling this error to the CAN-Gateway [operating mode] or being queried for presence and status information [diagnostic mode]) The Diagnostic mode is thus only available, when the vehicle is parked and connected to the cable bound. That’s why in parked/diagnostic mode, the LINs are able to state their presence and thus are listed along the CAN Ecus in the list of built-in ECUs. Data can only be provided if it is available in the vehicle. In case an ECU is not providing any data, the extended vehicle API cannot provide it either. 21. How can I interpret the DTCs? DTCs are provided as standardized machine-readable code by RDS. RDS does not provide a translation of the error codes. This information can be purchased directly from the OEM or from third-party suppliers for the respective divisions. 22. Is “odometer” included in the snapshot data which comes with a DTC? Odometer of first and last occurrence of DTCs are fields in the RDS snapshot-service. Under certain circumstances odometer information in the DTC snapshot data and malfunction indicator status may be stored, which due to the vehicle are smaller than the distance at the time of occurrence of the event. 23. Will there be any data provided regarding the battery status / voltage / voltage drop during cranking? Not directly, but indirectly if DTCs are forced by battery status. 24. What is included in data use case „Read Malfunction Indicator Status“? Use case 07 „Read Malfunction Indicator Status” includes warning and indicator messages for passenger cars and vans. These are outputted with code ID, icon and detailed descriptions. The maximum available number of these messages depends on the vehicle model generation. 25. What is included in the use case „Clear all DTCs“? Use case 08 “Clear all DTCs” clears all diagnostic trouble codes in the fault memory for passenger cars. Since this use case makes changes to the vehicle, a process connected with the vehicle head-unit is started which should ensure that the API Consumer has direct or indirect access to the vehicle in order to proceed with all required instruction steps. 26. Which prerequisites need to be fulfilled for the use case “Clear all DTCs”? Prerequisites: 1. An external diagnostic device must be disconnected from the vehicle’s OBD interface. If a diagnostic device was previously connected, the ignition must be switched off and switched on again and then a waiting time of 10 minutes must be observed. 2. The car has to be in an area with good mobile communication reception. 3. The ignition has to be switched on. 4. The engine must not run. 5. Transmission state has to be P or neutral. 6. The parking brake has to be engaged. 7. The engine hood has to be closed. 8. Stay in the car. 9. All doors have to be closed. 27. Which instructions steps are required to use “Clear all DTCs” successfully? Instructions: 1. After pressing the button “Start” there will appear a diagnostic request within the central display of the car. 2. Please confirm the diagnostic request within 30 seconds. 3. When the central display shows the note “Please follow the instructions received by phone and park your vechicle.” the ignition has to be switched off. 4. Follow the instructions on the central display until the message “successful” is shown. 5. When the central display shows the message “Vehicle diagnostics data is being transferred.” , please confirm by pressing “ok”. 6. If the central display shows a message “Vehicle diagnostics has failed. Do you want to restart vehicle diagnostics?” then please choose “yes” and follow the instructions on the central display.
40 Mercedes-Benz AG | B2B Partner Guidance 6 Appendix 1. Error codes list of MB Developers HTTP Error code Description 202 The request has been accepted for processing, but not completed. (not implemented) 204 The request has been accepted for processing, but no content is available. 206 Only partial content available. 400 The request could not complete due to malformed syntax. 401 Invalid or missing authorization in header. 402 Payment required. 403 Forbidden. 404 The requested resource was not found, e.g.: the selected vehicle could not be found. The resource identified by the request is not capable of generating a response that matches the given Accept 406 headers. 429 Quota limit is exceeded. 500 An error occurred on the server side, e.g. a required service did not provide a valid response. 501 The server does not support the functionality required. 503 The server is unable to service the request due to a temporary unavailability condition. 505 The server does not, or refuses to support the protocol associated with the request.
Mercedes-Benz AG | B2B Partner Guidance 41 Mercedes-Benz AG 70327 Stuttgart Germany www.mercedes-benz.com
You can also read