RajaOngkir API 客户端 PHP 项目教程
rajaongkir Klien API RajaOngkir untuk PHP. 项目地址: https://gitcode.com/gh_mirrors/ra/rajaongkir
1. 项目介绍
RajaOngkir 是一个用于访问 RajaOngkir API 的 PHP 库。RajaOngkir API 提供了印尼的物流信息查询服务,包括省份、城市、邮编、物流费用等。该项目旨在简化开发者与 RajaOngkir API 的交互过程,提供了一系列易于使用的 PHP 方法来获取物流相关的数据。
主要功能
- 获取所有省份列表
- 根据 ID 获取特定省份
- 根据名称搜索省份
- 获取所有城市/县列表
- 根据省份 ID 获取城市/县列表
- 根据 ID 获取特定城市/县
- 根据名称搜索城市/县
- 获取物流费用(运费)
待办功能
- 支持 Basic 和 Pro 账户类型的功能
- 使用 Fuse 进行模糊搜索
2. 项目快速启动
环境要求
- PHP 7.0 或更高版本(推荐使用 PHP 7.1 或更高版本)
安装
使用 Composer 安装 RajaOngkir 库:
composer require kavist/rajaongkir:^1.1
你也可以手动将依赖项添加到 composer.json
文件中:
{
"require": {
"kavist/rajaongkir": "^1.1"
}
}
配置
PHP Native
在实例化 RajaOngkir
类时,将 API 密钥作为参数传递:
use Kavist\RajaOngkir\RajaOngkir;
$rajaOngkir = new RajaOngkir('你的API密钥');
Laravel
对于 Laravel 5.5 及以上版本,该包会自动发现。你只需在环境变量中设置 RAJAONGKIR_API_KEY
:
RAJAONGKIR_API_KEY=你的API密钥
你还可以发布配置文件以进行更详细的配置:
php artisan vendor:publish --provider="Kavist\RajaOngkir\Providers\LaravelServiceProvider"
使用示例
获取省份列表
use Kavist\RajaOngkir\Facades\RajaOngkir;
$daftarProvinsi = RajaOngkir::provinsi()->all();
根据 ID 获取省份
$daftarProvinsi = RajaOngkir::provinsi()->find(11);
搜索省份
$daftarProvinsi = RajaOngkir::provinsi()->search('ja')->get();
获取城市/县列表
$daftarKota = RajaOngkir::kota()->all();
根据 ID 获取城市/县
$daftarKota = RajaOngkir::kota()->find(80);
根据省份 ID 获取城市/县
$daftarKota = RajaOngkir::kota()->dariProvinsi(11)->get();
搜索城市/县
$daftarKota = RajaOngkir::kota()->search('su')->get();
获取物流费用
$biayaPengiriman = RajaOngkir::ongkosKirim([
'origin' => 155, // 出发城市/县 ID
'destination' => 80, // 目的城市/县 ID
'weight' => 1300, // 重量(克)
'courier' => 'jne' // 快递公司代码
]);
3. 应用案例和最佳实践
案例1:电商物流费用计算
在电商平台上,用户选择商品后,系统需要根据用户选择的收货地址计算物流费用。使用 RajaOngkir 可以轻松实现这一功能。
$biayaPengiriman = RajaOngkir::ongkosKirim([
'origin' => 155, // 仓库所在城市/县 ID
'destination' => $userAddressId, // 用户选择的收货地址 ID
'weight' => $totalWeight, // 商品总重量
'courier' => 'jne' // 默认快递公司
]);
案例2:物流信息展示
在物流信息展示页面,用户可以查看所有可用的物流选项及其费用。
$daftarKurir = ['jne', 'tiki', 'pos'];
$results = [];
foreach ($daftarKurir as $kurir) {
$results[$kurir] = RajaOngkir::ongkosKirim([
'origin' => 155,
'destination' => 80,
'weight' => 1300,
'courier' => $kurir
]);
}
4. 典型生态项目
项目1:Laravel RajaOngkir
这是一个专门为 Laravel 框架优化的 RajaOngkir 客户端库,提供了更简洁的 API 和更好的集成体验。
项目2:RajaOngkir API 文档
该项目提供了 RajaOngkir API 的详细文档,包括所有可用端点和请求示例。
项目3:物流费用计算器
这是一个基于 RajaOngkir API 的物流费用计算器,用户可以输入出发地、目的地和货物重量,系统会返回所有可用快递公司的费用。
通过以上教程,你可以快速上手使用 RajaOngkir API 客户端 PHP 项目,并将其应用于各种物流相关的场景中。
rajaongkir Klien API RajaOngkir untuk PHP. 项目地址: https://gitcode.com/gh_mirrors/ra/rajaongkir