PHPackages                             emico/magento-2-robinhq - 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. [API Development](/categories/api)
4. /
5. emico/magento-2-robinhq

ActiveMagento2-module[API Development](/categories/api)

emico/magento-2-robinhq
=======================

Magento 2 module for RobinHQ integration. Provides API endpoints for RobinHQ dynamic API

v5.1.0(5mo ago)4251.4k—6.6%11[1 PRs](https://github.com/EmicoEcommerce/Magento2RobinHq/pulls)1OSL-3.0PHPPHP &gt;=8.0 &lt;=8.5

Since Jul 4Pushed 5mo ago8 watchersCompare

[ Source](https://github.com/EmicoEcommerce/Magento2RobinHq)[ Packagist](https://packagist.org/packages/emico/magento-2-robinhq)[ RSS](/packages/emico-magento-2-robinhq/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (10)Versions (67)Used By (1)

Magento 2 RobinHQ module
========================

[](#magento-2-robinhq-module)

[![Build Status](https://camo.githubusercontent.com/f17a6a4a1136d94a8d54d123f42cc1b7a9ca945862b83832ea1425a0f9f77fa2/68747470733a2f2f7472617669732d63692e636f6d2f456d69636f45636f6d6d657263652f4d6167656e746f32526f62696e48712e7376673f6272616e63683d6d6173746572)](https://travis-ci.com/EmicoEcommerce/Magento2RobinHq)

Provides API integrations with the RobinHQ platform / dashboards

Installation
------------

[](#installation)

Prerequisites

- Magento 2.4.4 or higher
- PHP 8.0 or higher

Install package using composer

```
composer require emico/magento-2-robinhq
```

Run installers

```
php bin/magento setup:upgrade
```

Dynamic API
-----------

[](#dynamic-api)

This module provides 5 endpoints for the RobinHQ dynamic API integration. This endpoints are called directly from within the RobinHQ dashboard, providing the latest up to date information from Magento.

The following endpoints are available:

- /robinhq/api/customer?email=`$EmailAddress`
- /robinhq/api/customerOrders?email=`$EmailAddress`
- /robinhq/api/order?orderNumber=`$Id`
- /robinhq/api/search?searchTerm=`$Expression`
- /robinhq/api/lifetime?email=`$Email`

Those are accessible from the root of your magento domain.

To enable the dynamic API functionality you have to enable it in the configuration.

`Stores` -&gt; `Configuration` -&gt; `Emico` -&gt; `RobinHQ` -&gt; `Enable dynamic API`

#### Authentication

[](#authentication)

The authentication of the dynamic API is done by a pre shared key which must be communicated to RobinHQ.

You can define an API key and secret in the RobinHQ configuration.

When issueing requests to the dynamic API endpoint you have to include a Basic authentication header. The value you have to sent is a base64-encoding of `{apiKey}:{apiSecret}`.

For example you have set up API key to `abc` and API secret to `def`. The value would be `base64(abc:def)`, which resolves to `YWJjOmRlZg==`. The full authorization header is: `Authorization: Basic YWJjOmRlZg==`

#### Customize panelview and detailview

[](#customize-panelview-and-detailview)

Some endpoints provide the possibility to provide custom data in the Robin dashboards.

For example when retrieving customer details using `/robinhq/api/customer` the following payload is returned.

```
{
    "naam": "Robin Doe",
    ...
    "panel_view": {
        "street": "Lovinklaan 1",
        ...
        "my_customfield1": "234",
        "loyalty_card_number": "1265645456"
    }
}

```

You can simply add custom attributes to these views in the configuration. `Stores` -&gt; `Configuration` -&gt; `Emico` -&gt; `RobinHQ` -&gt; `Custom Attributes` section.

When you need even more control or implement your own bussiness logic you can implement the interfaces `DetailViewProviderInterface` or `CustomerPanelViewProviderInterface`.

For example:

```
namespace MyVendor\MyModule;

class MyPanelViewProvider implements CustomerPanelViewProviderInterface
{
    public function getData(CustomerInterface $customer): array
    {
        return [
            'my_custom_field' => 'some value'
        ]
    }
}

```

Register in your `di.xml`

```

            MyVendor\MyModule\MyPanelViewProvider

```

Dynamic API POST requests
-------------------------

[](#dynamic-api-post-requests)

For complete integration with Robin dynamic API the Magento module needs to issue POST requests to the RobinHQ platform.

For this functionality to work correctly it is mandatory to have a working RabbitMQ instance. You can read more about setting this up in the [Magento documentation](https://devdocs.magento.com/guides/v2.3/install-gde/prereq/install-rabbitmq.html).

Use the following command to process the message queue: `bin/magento queue:consumers:start EmicoRobinHq`

You can configure this in a cronjob or preferably using supervisor.

Frontend widgets
----------------

[](#frontend-widgets)

This module provides a widget to display the RobinHQ tracking script on your website. This makes it possible to gain insight into all products viewed by the customer and the contents of the shopping cart. Should work out of the box with the default Luma theme.

See:

To enable this feature you have to enable it in the configuration.

`Stores` -&gt; `Configuration` -&gt; `Emico` -&gt; `RobinHQ` -&gt; `Enable viewed products tracking`

###  Health Score

61

—

FairBetter than 99% of packages

Maintenance72

Regular maintenance activity

Popularity41

Moderate usage in the ecosystem

Community25

Small or concentrated contributor base

Maturity91

Battle-tested with a long release history

 Bus Factor1

Top contributor holds 71.2% 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

Every ~48 days

Recently: every ~151 days

Total

50

Last Release

159d ago

Major Versions

v0.1.1 → v1.0.0-rc12019-09-25

v1.4.0 → v2.0.02022-05-20

v2.5.1 → v3.0.02024-02-21

v3.0.0 → v4.0.02024-03-13

v4.1.4 → v5.0.02025-05-06

PHP version history (9 changes)v0.1.0-beta1PHP ~7.2.0

v0.1.1PHP ^7.2.0

v1.0.0-rc1PHP ^7.1.0

v2.0.0PHP &gt;=7.4 &lt;=8.1

v2.0.2PHP &gt;=7.4 &lt;8.2

v2.4.1PHP &gt;=7.4 &lt;=8.2

v4.0.0PHP &gt;=8.0 &lt;=8.3

v4.1.4PHP &gt;=8.0 &lt;=8.4

v5.0.0PHP &gt;=8.0 &lt;=8.5

### Community

Maintainers

![](https://www.gravatar.com/avatar/5925aead0dc4b3ff1612f937c59e4a5bf185152498e128c28cff645d668212d4?d=identicon)[bramstroker](/maintainers/bramstroker)

---

Top Contributors

[![bramstroker](https://avatars.githubusercontent.com/u/2345875?v=4)](https://github.com/bramstroker "bramstroker (109 commits)")[![pmzandbergen](https://avatars.githubusercontent.com/u/8101295?v=4)](https://github.com/pmzandbergen "pmzandbergen (13 commits)")[![gdvisser](https://avatars.githubusercontent.com/u/34095508?v=4)](https://github.com/gdvisser "gdvisser (11 commits)")[![cjfloermans](https://avatars.githubusercontent.com/u/1148227?v=4)](https://github.com/cjfloermans "cjfloermans (8 commits)")[![Hnto](https://avatars.githubusercontent.com/u/6788268?v=4)](https://github.com/Hnto "Hnto (3 commits)")[![fazed](https://avatars.githubusercontent.com/u/5490437?v=4)](https://github.com/fazed "fazed (2 commits)")[![jansentjeu](https://avatars.githubusercontent.com/u/161043478?v=4)](https://github.com/jansentjeu "jansentjeu (2 commits)")[![stijnbernards](https://avatars.githubusercontent.com/u/6909174?v=4)](https://github.com/stijnbernards "stijnbernards (2 commits)")[![emico-jd](https://avatars.githubusercontent.com/u/112851860?v=4)](https://github.com/emico-jd "emico-jd (1 commits)")[![rutgerrademaker](https://avatars.githubusercontent.com/u/912316?v=4)](https://github.com/rutgerrademaker "rutgerrademaker (1 commits)")[![sanderjongsma](https://avatars.githubusercontent.com/u/2726055?v=4)](https://github.com/sanderjongsma "sanderjongsma (1 commits)")

###  Code Quality

TestsCodeception

### Embed Badge

![Health badge](/badges/emico-magento-2-robinhq/health.svg)

```
[![Health](https://phpackages.com/badges/emico-magento-2-robinhq/health.svg)](https://phpackages.com/packages/emico-magento-2-robinhq)
```

###  Alternatives

[mollie/magento2

Mollie Payment Module for Magento 2

1121.6M10](/packages/mollie-magento2)[dotdigital/dotdigital-magento2-extension

Dotdigital for Magento 2

50374.2k18](/packages/dotdigital-dotdigital-magento2-extension)[xcoreplatform/xcore-magento2

This module extends the rest api of Magento2 and is needed for the usage of the xCore.

1330.0k2](/packages/xcoreplatform-xcore-magento2)[pagbank/payment-magento

PagBank - Payment for Magento and Adobe

2128.3k7](/packages/pagbank-payment-magento)[mage-os/module-inventory-reservations-grid

Add a grid with the list of inventory reservations.

126.8k](/packages/mage-os-module-inventory-reservations-grid)

PHPackages © 2026

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