README

![Software License][shield-license]

Status: Under construction

Roadmap

• Implement environment
• Add further docs

Dependencies

• PHP: ^8.1

Install

You can install the package via Composer

composer require composite/laravel-tecdoc

In Laravel 5.5 or above the service provider will automatically get registered. In older versions of the framework just add the service provider in config/app.php file:

'providers' => [
    ...
    /*
     * Package Service Providers...
     */
    Composite\TecDoc\TecDocServiceProvider::class,
    ...
],

'aliases' => [
    ...
    'TecDoc' => Composite\TecDoc\Facades\TecDoc::class,
    ...
],

You can publish the config file with:

php artisan vendor:publish --provider="Composite\TecDoc\TecDocServiceProvider" --tag=config

When published, the config/tecdoc.php config file contains:

<?php

return [

    /*
    |--------------------------------------------------------------------------
    | TecDoc service url
    |--------------------------------------------------------------------------
    |
    | The service url of TecDoc REST API
    |
    */

    'service_url' => env('TEC_DOC_SERVICE_URL', "https://webservice.tecalliance.services/pegasus-3-0/services/TecdocToCatDLB.jsonEndpoint"),
    
    /*
    |--------------------------------------------------------------------------
    | API key (optional if IP is whitelisted)
    |--------------------------------------------------------------------------
    |
    | The user's API key for TecDoc REST API service.
    |
    */

    'api_key' => env('TECDOC_API_KEY'),
    
    /*
    |--------------------------------------------------------------------------
    | Provider ID
    |--------------------------------------------------------------------------
    |
    | The user's provider ID for TecDoc REST API service
    |
    */
    
    'provider_id' => env('TECDOC_PROVIDER_ID'),
    
    /*
    |--------------------------------------------------------------------------
    | Country code (ISO 3166)
    |--------------------------------------------------------------------------
    |
    | The user's registered country code (Country code according to ISO 3166)
    |
    */
    
    'country' => env('TECDOC_COUNTRY'),
    
    /*
    |--------------------------------------------------------------------------
    | Language code (ISO 639)
    |--------------------------------------------------------------------------
    |
    | Chosen language code for response (Language code according to ISO 639)
    |
    */
    
    'lang' => env('TECDOC_LANG'),
     
];

Usage

• Manufacturers, check out the manufacturers.md
• Model series, check out the modelSeries.md
• Vehicles, check out the vehicles.md
• Articles, check out the articles.md
• Addresses, check out the articles.md
• AssemblyGroups, check out the assemblyGroups.md

TecDoc::get(string $uri, array $payload = []);

TecDoc::post(string $uri, array $payload = []);

TecDoc::put(string $uri, array $payload = []);

TecDoc::delete(string $uri, array $payload = []);

TecDoc::manufacturers()->all(array $filter = null);

TecDoc::modelSeries()->findByNumber(int $manuId, array $filter = null);

TecDoc::vehicles()->find(int $carId, array $filter = null);

TecDoc::vehicles()->findByNumber(int $manuId, int $modId, array $filter = null);

TecDoc::articles()->filter(array $filter);

TecDoc::articles()->find(int $articleId, array $filter = null);

TecDoc::articles()->findByNumber(int $articleNumber, array $filter = null);

TecDoc::addresses()->add(string $address, int $validityHours = null);

TecDoc::assemblyGroups()->filter(int $linkingTargetId, string $linkingTargetType = null, array $filter = null, bool $recursive = false);

Testing

composer lint

Contributing

Security Vulnerabilities

If you discover any security-related issues, please email btamba@composite.hu instead of using the issue tracker. All security vulnerabilities will be promptly addressed.

Licence

The Laravel TecDoc package is open-source software licensed under the MIT license.