OpenAPI
  • Quick Start
  • Documentation
    • Instruction
    • Log Update
    • Glossary
  • Integration Instruction
    • Interface Specification
    • Callback Rules
    • Public Parameters
  • Best Practice
    • Integration Procedures
    • Integration Solution
  • Standardized Interface
    • Obtain Platform Access Credentials
    • Obtain Vehicle Health Check Report
    • Create Service Order Callback
    • Release Health Check Report Callback
      • Basic Integration: Embedded URL to H5 Health Check Report
      • Deep Integration: Comprehensive Health Check Result Data
    • Vehicle Condition & Maintenance Plan Callback
  • Customized Interface
    • Synchronize Vehicle Service Item Info
    • Synchronize Work Procedure Info
    • Synchronize Work Report Info
      • Basic Integration: Embedded URL to H5 Work Report
      • Deep Integration: Comprehensive Work Result Data
  • FAQ
    • Code Encryption DEMO
    • HTTPS Settings Instruction
  • ⚙️Translation
    • 简体中文
Powered by GitBook
On this page
  • Minimalist Solution
  • Advanced Solution
  • Complex Solution

Was this helpful?

  1. Best Practice

Integration Solution

Minimalist Solution

Premise: The developer only needs to use AutoX3's SAAS-based products to complete the check-in and inspection process, and display the health check report.

Solution: The developer obtains the health check report from the standardized interface of the current open platform directly.

Achievement:

  • The developer obtains the access credentials through the "Obtain Platform Access Credentials" interface;

  • The developer inputs in the license plate number and access credential parameters through the "Obtain Vehicle Health Check Report" interface to obtain the inspection report;

Advanced Solution

Premise: The developer hopes to use AutoX3’s SAAS-based products, combined with their systems, to complete the check-in, inspection process, and display the health check report, and to adjust the system according to some key events.

Solution: The developer obtains the health check report from the standardized interface of the current open platform and monitors the callback of the open platform.

Achievement:

  • The developer obtains the access credentials through the "Obtain Platform Access Credentials" interface;

  • The developer inputs in the license plate number and access credential parameters through the "Obtain Vehicle Health Check Report" interface to obtain the inspection report;

  • The developer receives the "Create Service Order Callback" and adjusts the system through the callback;

  • The developer receives the "Release Health Check Report Callback" and adjusts the system through the callback;

  • The developer receives the "Vehicle Condition & Maintenance Plan Callback" and adjusts the system through the callback;

Complex Solution

Premise: The minimalist and the advanced solution have a common premise, that is, the basic information (including vehicle information, brand information, service items, construction templates, etc.) are all from the AutoX3 open platform. The developer hopes to use AutoX3's SAAS-based products, combined with their systems, to complete the check-in, inspection process, display the Health Check report with the system information, and modify their systems according to some key events.

Solution: The developer needs to obtain the Health Check report from the standardized interface of the current open platform; to monitor the callback of the open platform to adjust systems; to synchronize the information of their systems to the open platform

Achievement:

  • The developer obtains the access credentials through the "Obtain Platform Access Credentials" interface;

  • The developer inputs in the license plate number and access credential parameters through the "Obtain Vehicle Health Check Report" interface to obtain the inspection report;

  • The developer receives the "Create Service Order Callback" and adjusts the system through the callback;

  • The developer receives the "Release Health Check Report Callback" and adjusts the system through the callback;

  • The developer receives the "Vehicle Condition & Maintenance Plan Callback" and adjusts the system through the callback;

  • The developer synchronizes its system's vehicle service item information to the open platform through "Synchronize Vehicle Service Item Info"

  • The developer synchronizes its system's work procedure information to the open platform through "Synchronize Work Procedure Info"

  • Developers obtain construction report results from the open platform through "Synchronize Work Report Info"

PreviousIntegration ProceduresNextObtain Platform Access Credentials

Last updated 3 years ago

Was this helpful?