Download the PHP package esign/laravel-plytix without Composer
On this page you can find all versions of the php package esign/laravel-plytix. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download esign/laravel-plytix
More information about esign/laravel-plytix
Files in esign/laravel-plytix
Package laravel-plytix
Short Description A Laravel SDK for the Plytix API
License MIT
Homepage https://github.com/esign/laravel-plytix
Informations about the package laravel-plytix
A Laravel SDK for the Plytix API
This package allow you to easily interact with the Plytix API.
Installation
You can install the package via composer:
The package will automatically register a service provider.
Next up, you can publish the configuration file:
The config file will be published as config/plytix.php with the following content:
Usage
This package leverages Saloon for sending requests to the Plytix API, providing an elegant way to interact with the API.
Authentication
After configuring your API key and password in the config file, authentication tokens are automatically managed by the package. There's no need to manually handle authentication tokens.
Rate limiting
The Plytix API enforces rate limits based on the subscription plan you’re on. You can configure these rate limits in the config/plytix.php
file under the rate_limiting section.
Sending requests
To send requests to the Plytix API, you may use the Esign\Plytix\Plytix
connector.
You can explore all the available request classes in the src/Requests directory.
Here’s an example of sending a request:
Response handling
This package uses DTOs (Data Transfer Objects) to simplify working with API responses. You can retrieve the DTO from the response like this:
Alternatively, you can retrieve the raw response data:
Paginating requests
For endpoints that return paginated data, you can easily paginate through the responses:
Additionally, you may also traverse through these pages using the items
or collect
methods.
For more information, refer to the Saloon pagination documentation.
Creating requests
Extending existing requests
If you need to customize or extend an existing request, you can create your own request class by extending the base request class:
Creating custom requests
If the request you need is not provided by the package, you can create a custom request using Saloon. First, install the Saloon Laravel plugin, then use the following command:
Testing
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-plytix with dependencies
illuminate/support Version ^10.0|^11.0
saloonphp/pagination-plugin Version ^2.2
saloonphp/rate-limit-plugin Version ^2.0
saloonphp/saloon Version ^3.8
spatie/laravel-data Version ^4.2