bildvitta/iss-crm

This is my package IssCrm

Fund package maintenance!
bildvitta

v0.0.16 2024-04-01 19:15 UTC

README

Latest Version on Packagist GitHub Code Style Action Status Total Downloads

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Support us

  • Customers (paginate, find).

Installation

You can install the package via composer:

composer require bildvitta/iss-crm

You can publish the config file with:

php artisan vendor:publish --provider="Bildvitta\IssCrm\IssCrmServiceProvider" --tag="iss-crm-config"

This is the contents of the published config file:

return [

    'base_uri' => env('MS_CRM_BASE_URI', 'https://api.almobi.com.br'),

    'prefix' => env('MS_CRM_API_PREFIX', '/api')
];

Config

In your .env file, associate the following variables.

# API base URL.
MS_CRM_BASE_URI="http://127.0.0.1:8001"

# API prefix if it exists.
MS_CRM_API_PREFIX="/api"

Usage

$issCrm = new \Bildvitta\IssCrm('jwt-hub');

$issCrm->customers()->search();
print_r($issCrm->customer()->find('uuid'));

This is result:

{
    "result": {
        "uuid": "effe4b02-f2eb-4ee0-9dbc-0d94ed30e532",
        "name": "Dr. Elias Artur Ferminiano",
        "phone": "(51) 90172-3741",
        "phone2": null,
        "email": "daniella52@example.org",
        "document": "683.387.679-72",
        "birthday": "1983-01-23",
        "...": "..."
    }
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.