heureka/overeno-zakazniky

Heureka 'Ověřeno zákazníky' (ShopCertification) service API implementation

v4.0.2 2023-10-16 07:06 UTC

Requires

• php: >=7.3

Requires (Dev)

• mockery/mockery: ~1.4.3
• phpunit/phpunit: ~9.5.0

Suggests

• ext-curl: Simplifies the library usage (you don't have to provide your own requester)

MIT

• Heureka.cz

README

Heureka Ověřeno zákazníky (ShopCertification) service API client implementation for PHP.

Note: For non-PHP implementations check the API documentation in the docs folder.

Examples

You can check working examples in the folder examples of this repository.

Usage

Initialize class Heureka\ShopCertification using your API key (you need to log in):

require_once __DIR__ . '/vendor/autoload.php';

$shopCertification = new \Heureka\ShopCertification('xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx');

Keep in mind that your API key is only yours and it is supposed to be a secret. Never post your API key to anyone, never put it into JavaScript or anywhere else. It should live on your server only. If you feel the need to break this rule then you are doing something wrong - please consult our support department prior to any actions.

SK shops should initialize the class with a service parameter in the options:

$options = ['service' => \Heureka\ShopCertification::HEUREKA_SK];
$shopCertification = new \Heureka\ShopCertification('xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', $options);

Set the customer e-mail address:

$shopCertification->setEmail('[e-mail]');

Set the customer's order ID (only integers are allowed):

$shopCertification->setOrderId(15195618851564);

Add products which the customer ordered (use IDs which you used in ITEM_ID field of the Heureka XML feed):

$shopCertification->addProductItemId('B1234');
$shopCertification->addProductItemId('15968421');
$shopCertification->addProductItemId('814687');

And finally send request to log the order:

$shopCertification->logOrder();