DOCSEARCHbyAlgolia
Submit Docs

Automotive Business Solutions (ABS) API Documentation

website·Indexed 31 days ago

https://docs.abswarranty.net

Developer documentation for Automotive Business Solutions (ABS) services, featuring a REST API for managing Tire Protection and Motor Club registrations, claims, and transactions. Includes guides on authentication via JWT and OpenSSH, SFTP file transfer for manufacturer, retail, and distributor programs, and API design specifications.

Tokens
19.1K
Snippets
66
Records
126
Agent score
49%

What's inside Automotive Business Solutions

  1. Overview of the Motor Club API

    The Motor Club API enables partners to manage consumer enrollment in benefits programs through Motor Club Registrations. Key capabilities include creating, viewing, and canceling registrations, as well as filing claims against active registrations. All API requests must be authenticated using a signed JSON Web Token (JWT). All endpoints for this service are prefixed with the motor-club category.

  2. Overview of the Tire Protection API

    The Tire Protection API enables partners to manage Tire Protection Registrations, which are used to enroll consumers in warranty programs. All requests to this API must be authenticated using a signed JSON Web Token (JWT). For new implementations, all API endpoints are prefixed with the tire-protection category in the URL path.

  3. Overview of the deprecated TPP API

    The TPP API is used to send ABS registrations, cancellations, claims, and sales data. Note: This version of the API is deprecated and no longer supported. It uses a REST protocol requiring a FORM POST with authorization headers and a JSON body.

  4. Understand the Terms of Use for docs.abswarranty.net

    The docs.abswarranty.net website is provided by ABS Operations, LLC (doing business as Automotive Business Solutions) for informational, non-commercial use. The website is provided on an 'AS-IS' and 'AS-AVAILABLE' basis. By accessing the site, users agree to comply with the Terms of Use. The service disclaims all warranties, including implied warranties of merchantability and fitness for a particular purpose.

  5. Understand the ABS file ingestion process

    Once a file is transferred via SFTP, it enters a queue and is processed in real-time automatically. If the ingestion process fails, the ABS engineering team is alerted and will review the issue during business hours (Monday – Friday, 9 AM – 5 PM Mountain Time) and contact the user to resolve it.

  6. Understand the ABS REST API design and endpoint structure

    The ABS API follows REST architectural principles. Endpoints are structured as METHOD https://BASE_URL/CATEGORY/RESOURCE/ID.

    • Methods: POST (Create), GET (Read/List), and PATCH (Partial Update).
    • Categories: Tire Protection or Motor Club.
    • Resources: registrations or claims.
    • ID: A specific instance of a resource.

    Note: Not all methods are available for every resource, and not all resources are available in every category.

  7. Claim object schema for Motor Club API

    The Claim object is used as the request body when creating a claim. It requires details about the invoice, service, and the vehicle involved.
    {
  "invoiceNumber": "001-20345",
  "internalReferenceNumber": "ABC1234",
  "serviceType":"reimbursement",
  "serviceInvoiceDate": "2024-09-15T15:00:00.000",
  "language": "en",
  "vehicle": {
    "year": 2021,
    "make": "Tesla",
    "model": "Model 3",
    "vin": "1234",
    "plateNumber": "xxxx",
    "plateState": "CO",
    "mileage": 12222
  }
}

  8. Understand the ABS REST API endpoint structure

    The ABS API follows REST architectural principles. Endpoints are generally structured as: METHOD https://BASE_URL/CATEGORY/RESOURCE/ID.

    • Methods: POST (Create), GET (Read/List), and PATCH (Partial Update).
    • Categories: Tire Protection or Motor Club.
    • Resources: registrations or claims.
    • ID: The specific instance identifier of a resource.

  9. Choose a data transfer method for ABS Warranty

    ABS Warranty provides three primary methods for integrating systems and transferring customer data to facilitate service delivery:

    1. API Integration: A suite of APIs for integration with POS, eCommerce platforms, ERPs, or custom stacks. This is recommended for the best user and customer experience.
    2. CSV over SFTP: A fully automated file-based approach where CSV files are uploaded to an ABS Warranty SFTP server. This is preferred for simplicity and flexibility.
    3. Plug and Play: Pre-built integrations with major eCommerce and POS vendors (currently in development/request phase).

  10. Generate an SSH key on Linux using OpenSSH

    Use the terminal to generate an RSA key pair for ABS SFTP authentication:

    1. Navigate to the directory where you wish to store the key.
    2. Run the ssh-keygen command.
    3. Press enter through the passphrase prompts to leave them empty (required for automation).
    4. Use cat to display the public key.
    5. Copy the entire public key string and email it to engineering@abswarranty.net.
    ssh-keygen -t rsa -f key
cat key.pub

  11. Opt out of marketing emails

    Users can unsubscribe from marketing emails by clicking the unsubscribe link within the email or by contacting the company. Alternatively, users can update their preferences within their account settings. Note that service-related emails necessary for account administration or service requests will still be sent after opting out of marketing.

  12. Requirements for User Generated Contributions

    When submitting content (text, video, audio, graphics, etc.) to docs.abswarranty.net, users must warrant that their contributions:

    • Do not infringe on third-party proprietary rights (copyright, patent, trademark).
    • Are owned by the user or have necessary licenses/permissions for use by the website.
    • Have written consent from any identifiable individuals appearing in the content.
    • Are accurate and not misleading.
    • Are not spam, unauthorized advertising, or promotional material.
    • Are not obscene, violent, harassing, or discriminatory (based on race, gender, national origin, etc.).
    • Do not violate any applicable laws, including those protecting minors.