README

文档

Naqel API 的文档可以在这里找到。

支持的 PHP 版本

此库支持以下 PHP 实现

• PHP 7.4
• PHP 8.0

安装

您可以通过 composer 安装 naqel-php 或下载源代码。

通过 Composer

naqel-php 以 naqel/sdk 包的形式在 Packagist 上提供

composer require naqel/sdk

快速入门

使用您的凭据和信息设置配置

$naqel = new \Naqel\Naqel([
    'use_sandbox' => true,
    'client_id'   => '[YOUR_CLIENT_ID]',
    'password'    => '[YOUR_CLIENT_PASSWORD]',
    'version'     => '9.0',
]);

// Set your address
$clientAddress = (new \Naqel\Models\ClientAddress())
    ->setPhoneNumber('0555555555')
    ->setFirstAddress('King Abdulaziz Street')
    ->setCountryCode('KSA')
    ->setCityCode('RUH');

// Set your contact
$clientContact = (new \Naqel\Models\ClientContact())
    ->setName('Mohammad')
    ->setPhoneNumber('05xxxxxxxx');

// Attach both address and contact to Naqel instance
$naqel->setClientAddress($clientAddress);
$naqel->setClientContact($clientContact);

设置收货人信息

$consigneeInfo = (new \Naqel\Models\ConsigneeInfo())
    ->setConsigneeName('Abdullah')
    ->setPhoneNumber('05xxxxxxxx')
    ->setAddress('King Salman Street')
    ->setCountryCode('KSA')
    ->setCityCode('RUH');

设置托运清单

$manifestShipment = (new \Naqel\Models\ManifestShipment())
    ->setConsigneeInfo($consigneeInfo)
    ->setBillingType(\Naqel\Constants\BillingType::ON_ACCOUNT)
    ->setLoadTypeID(\Naqel\Constants\LoadType::NON_DOCUMENT)
    ->setPiecesCount(1)
    ->setWeight(1.0);

创建带有清单的新运单

$waybill = \Naqel\Waybill::create($manifestShipment);

或者，您可以通过其编号获取运单实例

$waybill = \Naqel\Waybill::create($waybill->number());

获取运单编号

$waybillNumber = $waybill->number();

获取作为 PDF 内容的运单标签

$sticker = $waybill->printSticker(
    \Naqel\Constants\StickerSize::FourMFourInches
);

版本控制

naqel-php 使用 SemVer 进行版本控制。有关可用的版本，请参阅此存储库的标签。

贡献

请阅读 CONTRIBUTING.md 了解我们的行为准则以及向我们提交拉取请求的流程。

许可证

此项目采用 MIT 许可证 - 有关详细信息，请参阅 LICENSE 文件