Download the PHP package bannerstop/helix-sdk without Composer
On this page you can find all versions of the php package bannerstop/helix-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Please rate this library. Is it a good library?
Informations about the package helix-sdk
Helix SDK for PHP
Features
- Authentication: Easy token-based session management using
CredentialsTokenProvider. - Order Conversion: Support for various ecommerce formats:
- Mention (Order & Item structure)
- Magento (Order & Product structure)
- Generic Converter: Flexible data mapping with
GenericRequestDto. - Type Safety: Uses modern PHP features and DTOs to ensure data integrity.
- Error Handling: Custom exceptions for authentication and API failures.
Installation
Install the SDK via Composer:
Ensure your environment meets the minimum requirements:
- PHP 7.4 or higher
ext-jsonextension- Symfony HTTP Client & Serializer components
Quick Start
1. Simple Authentication
The SDK provides a standard CredentialsTokenProvider which handles automatic token retrieval from your login credentials.
2. Using the Helix Client
Instantiate the main client with the token provider.
3. Example: Convert a Magento Order
Available Operations
Specific Converters
| Method | Request Object | Description |
|---|---|---|
convertMentionOrder |
MentionOrderDto |
Converts items from the Mention platform format. |
convertMagentoOrder |
MagentoOrderDto |
Converts orders from Magento format. |
convertMagentoProduct |
MagentoProductDto[] |
Batch conversion of Magento product data. |
genericConvert |
GenericRequestDto |
Universal endpoint for custom conversion logic. |
Error Handling
The SDK throws descriptive exceptions:
Helix\Sdk\Exception\AuthenticationException: Thrown when login fails or credentials are invalid.Helix\Sdk\Exception\HelixApiException: Thrown when an API request fails or returns an error status code.
Development and Architecture
This project strictly follows the PSR-4 standard and is based on a clean, decoupled architecture:
- Auth: Contracts and implementations for token management.
- Client: The public interface for interacting with the Helix API.
- Dto: Data Transfer Objects for strongly typed request/response interaction.
- Exception: Specialized exception hierarchy.
License
This library is released under the MIT License. See LICENSE for details.
All versions of helix-sdk with dependencies
PHP Build Version
Package Version
Requires
php Version
>=7.4
symfony/http-client Version ^5.4 || ^6.0 || ^7.0 || ^8.0
symfony/serializer Version ^5.4 || ^6.0 || ^7.0 || ^8.0
symfony/property-access Version ^5.4 || ^6.0 || ^7.0 || ^8.0
symfony/property-info Version ^5.4 || ^6.0 || ^7.0 || ^8.0
phpdocumentor/reflection-docblock Version ^5.0
ext-json Version *
symfony/http-client Version ^5.4 || ^6.0 || ^7.0 || ^8.0
symfony/serializer Version ^5.4 || ^6.0 || ^7.0 || ^8.0
symfony/property-access Version ^5.4 || ^6.0 || ^7.0 || ^8.0
symfony/property-info Version ^5.4 || ^6.0 || ^7.0 || ^8.0
phpdocumentor/reflection-docblock Version ^5.0
ext-json Version *
The package bannerstop/helix-sdk contains the following files
Loading the files please wait ...