README

The DeliveryMatch Plugin Development Kit (PDK) is built for creating easy integrations with PHP E-commerce platforms. This library is a wrapper around the SDK

Requirements

• PHP >= 8.1
• A PSR-17 implementation
• A PSR-18 implementation
• Composer

Getting Started

Install the package using Composer:

composer require deliverymatch/pdk

Implement the Repository interface

During the checkout process the PDK needs access the same data across multiple requests. Most E-commerce platforms give you access to cookie, session, cache and database storage.

class MyWebshopDataRepository implements \DeliveryMatch\Pdk\Common\Repository 
{
    public function setShipmentId(int $shipmentId): void
    {
        Session::set($shipmentId, "dm_shipment_id");
    }

    public function getShipmentId(): ?int
    {
        return Session::get("dm_shipment_id");
    }

    public function setShippingOptions(array $shippingOptions): void
    {
        $shipmentId = $this->getShipmentId();

        Redis::save(key: $shipmentId, base64_encode(serialize($shippingOptions)));
    }

    public function getShippingOptions(): array
    {
        $shipmentId = $this->getShipmentId();

        if ($shipmentId === null) {
            return [];
        }

        $serializedOptions = Redis::get(key: $shipmentId);

        return unserialize(base64_decode($serializedOptions));
    }

    public function setCheckId(string $checkId): void
    {
        Session::set($checkId, "dm_check_id");
    }

    public function getCheckId(): ?string
    {
        return Session::get("dm_check_id");
    }

    public function flush(): void
    {
        $shipmentId = $this->getShipmentId();
        Redis::flush(key: $shipmentId);
        Session::clear("dm_check_id");
        Session::clear("dm_shipment_id");
    }
}

Create a PDK Bootstrapper

The Bootstrapper is used to provide the dependency injection container in de PDK with an implementation of the Repository interface. After the creation of the bootstrapper call the ::setup() method to initialize everything.

class MyWebshopPdkBootstrapper extends \DeliveryMatch\Pdk\Common\PdkBootstrapper
{
    protected function getAdditionalConfiguration(): array
    {
        return [
            \DeliveryMatch\Pdk\Common\Repository::class => \DI\autowire(MyWebshopDataRepository::class),
        ];
    }
}

Interact with the PDK

Once the PDK is successfully bootstrapped you can use the PDK to interact with DeliveryMatch using the \Facade\Pdk.

Check if the API connection is successful:

$isAuthenticated = \DeliveryMatch\Pdk\Facade\Pdk::checkConnection();

Fetch shipping options:

$rates = \DeliveryMatch\Pdk\Facade\Pdk::fetchShippingOptions($request);

Store the selected shipping option in the PDK:

\DeliveryMatch\Pdk\Facade\Pdk::setSelectedOption($this->request->checkId);

Push the selected shipping option to DeliveryMatch. (Not efficient to do this after every method change in the checkout, best to do this after the checkout is completed)

\DeliveryMatch\Pdk\Facade\Pdk::addShippingOptionToShipment();

Flush the repository when the checkout is completed. Store the shipment id with the corresponding order from the E-commerce platform.

// add shipping option to DeliveryMatch
\DeliveryMatch\Pdk\Facade\Pdk::addShippingOptionToShipment();

// Get the repository to fetch the shipment id
$repository = \DeliveryMatch\Pdk\Facade\Pdk::get(\DeliveryMatch\Pdk\Common\Repository::class);
$shipmentId = $cache->getShipmentId;

// Fetch E-Commerce order from the database
// Store dm shipmentId with the order
$eComOrder = Orders::get(123);
$eComOrder->dm_shipment_id = $shipmentId;
$eComOrder->save();

// Flush repository
$repository->flush();

Update the shipment to new when the payment is received. You also have the option to update the order number. Not all E-commerce platforms provide an oder number before the checkout is completed.

\DeliveryMatch\Pdk\Facade\Pdk::updateShipmentToNew(shipmentId: $shipmentId, orderNumber: $order->number);