rdj/rajaongkir

此包便于使用 Raja Ongkir API

1.0.0 2021-09-23 12:39 UTC

This package is auto-updated.

Last update: 2024-09-04 09:05:52 UTC


README

此包旨在简化使用 Raja Ongkir 服务 API

安装包 Composer

安装此包有 2 种方法

  1. 通过 "composer" 安装
$ composer require rdj/rajaongkir "dev-master"
  1. 在 composer.json 中手动添加

    步骤 1

    {
       ...
       "require"{ 
            "rdj/rajaongkir" : "dev-master"
       }
    }
    

    步骤 2

    $ composer update
    

Laravel 集成

在文件 config/app.php 中注册提供者

'providers' => [
	// ...

	Rdj\Rajaongkir\RajaongkirServiceProvider::class,
]

在相同的文件中添加别名 facade

'aliases' => [
	// ...

	'Rajaongkir' => Rdj\Rajaongkir\Facades\Rajaongkir::class,
]

使用以下命令发布包配置文件

$ php artisan vendor:publish

环境设置 (.env)

编辑文件 .env 添加以下代码

RAJAONGKIR_APIKEY=your_api_key_raja_ongkir
RAJAONGKIR_TYPE=your_type_account(e.g:starter or basic or pro)

使用方法

以下是如何使用此包的说明

- 获取省份数据

$getData = Rajaongkir::setEndpoint('province')
                    ->setBase(env("RAJAONGKIR_TYPE"))
                    ->setQuery([])
                    ->get();
        
return response()->json( $getData['rajaongkir'] );

- 通过 id 获取省份数据

$id = 12;
$getData = Rajaongkir::setEndpoint('province')
                    ->setBase(env("RAJAONGKIR_TYPE"))
                    ->setQuery(['id' => $id])
                    ->get();
        
return response()->json( $getData['rajaongkir'] );

- 获取城市数据

$getData = Rajaongkir::setEndpoint('city')
                    ->setBase(env("RAJAONGKIR_TYPE"))
                    ->setQuery([])
                    ->get();
        
return response()->json( $getData['rajaongkir'] );

- 通过 id 获取城市数据

$id = 12;
$getData = Rajaongkir::setEndpoint('city')
                    ->setBase(env("RAJAONGKIR_TYPE"))
                    ->setQuery(['id' => $id])
                    ->get();
        
return response()->json( $getData['rajaongkir'] );

- 通过 id 获取区/县数据(仅限专业账户)

$id = 12;
$getData = Rajaongkir::setEndpoint('subdistrict')
                    ->setBase(env("RAJAONGKIR_TYPE"))
                    ->setQuery(['id' => $id])
                    ->get();
        
return response()->json( $getData['rajaongkir'] );

- 获取运费数据(专业账户)

$request = [
   "origin" => "501",
   "originType"  => "city",
   "destination" => "574",
   "destinationType" => "subdistrict",
   "weight" => 1700,
   "courier" => "jne"
];
        
$getData = Rajaongkir::setEndpoint('cost')
                    ->setBase(env("RAJAONGKIR_TYPE"))
                    ->setBody($request)
                    ->post();
        
return response()->json( $getData['rajaongkir'] );

- 获取运费数据(入门版和基本版账户)

$request = [
   "origin" => "501",
   "destination" => "574",
   "weight" => 1700,
   "courier" => "jne"
];
        
$getData = Rajaongkir::setEndpoint('cost')
                    ->setBase(env("RAJAONGKIR_TYPE"))
                    ->setBody($request)
                    ->post();
        
return response()->json( $getData['rajaongkir'] );

Raja Ongkir API 文档

要了解有关 Raja Ongkir API 的更多信息,请访问

贡献

欢迎 Pull 请求。对于重大更改,请先提出问题以讨论您想要更改的内容。

请确保根据需要更新测试。

许可证

此包遵循 MIT 许可证