PHPackages                             bannerstop/helix-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. bannerstop/helix-sdk

ActiveLibrary[Utility & Helpers](/categories/utility)

bannerstop/helix-sdk
====================

Helix SDK for PHP

1.0.0(3mo ago)012↓90.9%MITPHPPHP >=7.4

Since Apr 2Pushed 3mo agoCompare

[ Source](https://github.com/bannerstop/helix-sdk)[ Packagist](https://packagist.org/packages/bannerstop/helix-sdk)[ RSS](/packages/bannerstop-helix-sdk/feed)WikiDiscussions master Synced 4w ago

READMEChangelog (1)Dependencies (5)Versions (2)Used By (0)

Helix SDK for PHP
=================

[](#helix-sdk-for-php)

[![PHP Version](https://camo.githubusercontent.com/0e9ac047546796cfdbe1423d1f4d91c8f37d2fbb11614a7900bb7686aaa5401f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d253345253344253230372e342d3838393242462e737667)](https://php.net)

Features
--------

[](#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
------------

[](#installation)

Install the SDK via Composer:

```
composer require bannerstop/helix-sdk
```

Ensure your environment meets the minimum requirements:

- PHP 7.4 or higher
- `ext-json` extension
- Symfony HTTP Client & Serializer components

Quick Start
-----------

[](#quick-start)

### 1. Simple Authentication

[](#1-simple-authentication)

The SDK provides a standard `CredentialsTokenProvider` which handles automatic token retrieval from your login credentials.

```
use Helix\Sdk\Auth\CredentialsTokenProvider;
use Symfony\Component\HttpClient\HttpClient;

$httpClient = HttpClient::create();
$baseUrl = 'https://api.helix-converter.com';

$tokenProvider = new CredentialsTokenProvider(
    $httpClient,
    $baseUrl,
    'your-username',
    'your-password'
);
```

### 2. Using the Helix Client

[](#2-using-the-helix-client)

Instantiate the main client with the token provider.

```
use Helix\Sdk\Client\HelixClient;

$client = new HelixClient($httpClient, $tokenProvider, $baseUrl);
```

### 3. Example: Convert a Magento Order

[](#3-example-convert-a-magento-order)

```
use Helix\Sdk\Dto\Request\MagentoOrderDto;
use Helix\Sdk\Dto\Request\MagentoProductDto;
use Helix\Sdk\Dto\Request\ProductOptionDto;

$items = [
    new MagentoProductDto('SKU-123', 'My Product', [
        new ProductOptionDto('Size', 'XL'),
        new ProductOptionDto('Color', 'Blue')
    ])
];

$order = new MagentoOrderDto($items);

try {
    $response = $client->convertMagentoOrder($order);
    if ($response->converted !== null) {
        foreach ($response->converted->items as $item) {
            // Processing results (e.g., converted product data)
            echo "Converted Product: " . $item->name . " (SKU: " . $item->sku . ")\n";
        }
    }
} catch (\Helix\Sdk\Exception\HelixApiException $e) {
    echo "API Error: " . $e->getMessage();
}
```

Available Operations
--------------------

[](#available-operations)

### Specific Converters

[](#specific-converters)

MethodRequest ObjectDescription`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

[](#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
----------------------------

[](#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
-------

[](#license)

This library is released under the MIT License. See [LICENSE](./LICENSE) for details.

###  Health Score

34

—

LowBetter than 75% of packages

Maintenance82

Actively maintained with recent releases

Popularity8

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity34

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

91d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/28f157ab08162319e7ad1983e00b7f3ae62df5ebd668f90e446593eea53fd0e4?d=identicon)[bannerstop](/maintainers/bannerstop)

---

Top Contributors

[![mkrykwinski](https://avatars.githubusercontent.com/u/2440497?v=4)](https://github.com/mkrykwinski "mkrykwinski (3 commits)")

### Embed Badge

![Health badge](/badges/bannerstop-helix-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/bannerstop-helix-sdk/health.svg)](https://phpackages.com/packages/bannerstop-helix-sdk)
```

###  Alternatives

[craftcms/cms

Craft CMS

3.6k3.6M3.0k](/packages/craftcms-cms)[web-auth/webauthn-framework

FIDO2/Webauthn library for PHP and Symfony Bundle.

515100.5k3](/packages/web-auth-webauthn-framework)[2lenet/crudit-bundle

The easy like Crud'it Bundle.

1716.4k12](/packages/2lenet-crudit-bundle)[api-platform/core

Build a fully-featured hypermedia or GraphQL API in minutes!

2.6k51.2M324](/packages/api-platform-core)[symfony/ai-agent

PHP library for building agentic applications.

32870.1k93](/packages/symfony-ai-agent)[web-auth/webauthn-lib

FIDO2/Webauthn Support For PHP

12310.5M127](/packages/web-auth-webauthn-lib)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)