wpify/heureka-hcapi

Heureka 购物车 API

v1.0.2 2023-08-03 14:15 UTC

This package is auto-updated.

Last update: 2024-09-16 11:29:26 UTC


README

Hcapi 是一个工具,旨在简化购物顾问 Heureka.cz 与希望使用这些服务及购物车的商店之间的连接。

使用方法

使用 composer 安装

composer require wpify/heureka-hcapi

实现

在本节中,您将找到将 hcapi 实现到您的项目的指南。

通过 Callable 连接

连接您商店的 HCAPI 的第一种方式是使用 Callable 回调。

在您的代码中,必须创建函数(对于所有服务),这些函数接收来自 Heureka 的数据(数组),处理它们并返回所需的数据(数组)。所需数据结构可以在此处找到。

支付/状态 函数的示例

//PaymentStatus.php

public function setPaymentStatus($receiveData)
    {
        //set payment status for order

        return [
            'status' => false,
        ];
    }

第二步,您必须将这两个函数与您的路由连接起来。您必须为 API 中的每个方法使用特定的服务。例如 支付/状态

//Router.php

if ($_SERVER['REQUEST_URI'] === 'https://www.example.com/api/1/payment/status') {
            $service = new PaymentStatus();
            return $service->processData(
                [
                    'Hcapi\Example\CallableExample\PaymentStatus',
                    'setPaymentStatus',
                ],
                $receiveData);
        }

服务位于 /src/Services/ 更多示例位于 /example/InterfaceExample/

通过接口实现

连接您商店的 HCAPI 的第二种方式是通过接口。在 /scr/Interfaces/ 文件夹中位于 IShopImplementation.php 接口。您必须为所有处理 Heureka 数据的类实现此接口。

示例

class OrderCancel implements IShopImplementation
{
    /**
     * @param array $receiveData
     *
     * @return array
     */
    public function getResponse($receiveData)
    {
        //Do something with receive data

        return [
            'status' => true,
        ];
    }

}

第二步,您必须将此函数与您的路由连接起来。您必须为 API 中的每个方法使用特定的服务。例如 订单/取消

if ($_SERVER['REQUEST_URI'] === 'https://www.example.com/api/1/order/cancel') {
    $service = new OrderCancel();
    $orderCancel = new \Hcapi\Example\InterfaceExample\OrderCancel();

    return $service->processData($orderCancel, $receiveData);
}

更多示例位于 /example/CallableExample/