README

开发。连接。交付。轻松使用 #KiriminAja。

这个库是 KiriminAja API 的抽象，用于从用 PHP 编写的应用程序中进行访问。

文档 · 联系我们 · 有趣的 Instagram 账户 · 博客

安装

使用以下命令通过 composer 安装 kiriminaja-php

composer require kiriminaja/kiriminaja-php

或者手动在您的 composer.json 文件中添加。

使用方法

使用从 KiriminAja 文档分配中获得的您的账户密钥配置包。

// When on your dev/stag 
KiriminAjaConfig::setMode(Mode::Staging)::setApiTokenKey('YOUR_KEY');

// When on your production
KiriminAjaConfig::setMode(Mode::Production)::setApiTokenKey('YOUR_KEY');

可用服务

KiriminAja::getCity((int) $province_id);
KiriminAja::getDistrict((int) $district_id);
KiriminAja::getDistrictByName((string) $keyword);
KiriminAja::getProvince();
KiriminAja::setWhiteListExpedition((array) $services);
KiriminAja::setCallback((string) $url);
KiriminAja::getPrice(ShippingPriceData $data);
KiriminAja::requestPickup(RequestPickupData $data);
KiriminAja::getPayment((string) $payment_id);
KiriminAja::cancelShipment((string) $waybill,(string)  $reason);
KiriminAja::getTracking((string) $package_id);
KiriminAja::getSchedules();

获取价格示例

public function get_price() {
    $shipping_price_object = new ShippingPriceData;
    $shipping_price_object->origin = 1063;
    $shipping_price_object->destination = 1064;
    $shipping_price_object->weight = 1000;
    $shipping_price_object->insurance = 1;
    $shipping_price_object->item_value = 100000;
    $shipping_price_object->courier = ['jne', 'jnt', 'sicepat'];
    return KiriminAja::getPrice($shipping_price_object);
}

请求取件示例

public function request_pickup() {
    $pickup_object = new RequestPickupData;
    $pickup_object->address = "Jl. Jodipati No.29 Perum Taman Kencana Sejahtera";
    $pickup_object->phone = "082129627860";
    $pickup_object->name = "dipaferdian";
    $pickup_object->kecamatan_id = 5784;
    $pickup_object->schedule = "2022-11-03 17:00:00";
    $pickup_object->zipcode = 16610;
    $pickup_object->platform_name = 'mitra';
    // Array of packages
    $pickup_object->packages = [];

    // Package object
    $package_data = new PackageData;
    $package_data->order_id = "DEV-2300000024";
    $package_data->destination_name = "Flag Test3";
    $package_data->destination_phone = "082223323333";
    $package_data->destination_address = "Jl. Magelang KM 11";
    $package_data->destination_kecamatan_id = 419;
    $package_data->destination_zipcode = 55598;
    $package_data->weight = 520;
    $package_data->width = 8;
    $package_data->height = 8;
    $package_data->length = 8;
    $package_data->item_value = 275000;
    $package_data->shipping_cost = 65000;
    $package_data->service = "sicepat";
    $package_data->service_type = "SIUNT";
    $package_data->item_name = "Test item name";
    $package_data->package_type_id = 1;
    $package_data->cod = 0;
    $package_data->note = 'test pickup request non cod';
    $package_data->drop = true;
    
    // Bind package object to packages
    $pickup_object->packages = [$package_data];
    
    return KiriminAja::requestPickup($pickup_object);
}

贡献

对于任何请求、错误或评论，请打开 问题 或 提交一个拉取请求。

安装包

在开始编码之前，运行此命令以安装所有必需的包。请确保您已经在计算机上安装了 composer

composer install

测试

运行测试套件

vendor\bin\phpunit tests

运行示例

php examples\InvoiceExample.php

存在一个预提交钩子来运行 phpcs 和 phpcbf。请在进行提交/推送之前确保它们已通过。