README

Laravel RajaOngkir API 包。

要求

• Laravel v5.5.*
• guzzlehttp/guzzle v6.3.3

安装

使用以下命令通过 composer 安装此包：

composer require agungtri222/laravel-rajaongkir

配置

此包需要一些配置才能使用 RajaOngkir API 服务。将这些行添加到您的 .env 文件中，然后根据您的偏好更新相应的值。

RAJAONGKIR_ENDPOINT=
RAJAONGKIR_API_KEY=

通过命令发布包配置

php artisan vendor:publish --provider="Agungtri222\RajaOngkir\Providers\RajaOngkirServiceProvider" --tag=config

RajaOngkir 服务外观

此包提供管理 RajaOngkir API 请求的功能，以及有用的外观 RajaOngkir。

城市

使用语法 RajaOngkir::city()。

这将返回所有城市数据的数组。

见以下示例。

    229 => array:6 [
      "city_id" => "230"
      "province_id" => "21"
      "province" => "Nanggroe Aceh Darussalam (NAD)"
      "type" => "Kota"
      "city_name" => "Langsa"
      "postal_code" => "24412"
    ]
    230 => array:6 [
      "city_id" => "231"
      "province_id" => "24"
      "province" => "Papua"
      "type" => "Kabupaten"
      "city_name" => "Lanny Jaya"
      "postal_code" => "99531"
    ]
    231 => array:6 [
      "city_id" => "232"
      "province_id" => "3"
      "province" => "Banten"
      "type" => "Kabupaten"
      "city_name" => "Lebak"
      "postal_code" => "42319"
    ]

如果您想按指定城市 ID 和省份 ID 搜索，请使用 RajaOngkir::city($cityId, $provinceId)，其中字符串参数为 $cityId 和 $provinceId

它将返回响应数据的数组。见以下示例。

array:3 [
  "query" => array:2 [
    "city" => "39"
    "province" => "5"
  ]
  "status" => array:2 [
    "code" => 200
    "description" => "OK"
  ]
  "results" => array:5 [
    0 => array:6 [
      "city_id" => "39"
      "province_id" => "5"
      "province" => "DI Yogyakarta"
      "type" => "Kabupaten"
      "city_name" => "Bantul"
      "postal_code" => "55715"
    ]
    1 => array:6 [
      "city_id" => "135"
      "province_id" => "5"
      "province" => "DI Yogyakarta"
      "type" => "Kabupaten"
      "city_name" => "Gunung Kidul"
      "postal_code" => "55812"
    ]
    2 => array:6 [
      "city_id" => "210"
      "province_id" => "5"
      "province" => "DI Yogyakarta"
      "type" => "Kabupaten"
      "city_name" => "Kulon Progo"
      "postal_code" => "55611"
    ]
    3 => array:6 [
      "city_id" => "419"
      "province_id" => "5"
      "province" => "DI Yogyakarta"
      "type" => "Kabupaten"
      "city_name" => "Sleman"
      "postal_code" => "55513"
    ]
    4 => array:6 [
      "city_id" => "501"
      "province_id" => "5"
      "province" => "DI Yogyakarta"
      "type" => "Kota"
      "city_name" => "Yogyakarta"
      "postal_code" => "55111"
    ]
  ]
]

省份

使用语法 RajaOngkir::province()。

如果您想按指定城市 ID 和省份 ID 搜索，请使用 RajaOngkir::province($provinceId)，其中字符串参数为 $provinceId

货币

使用语法 RajaOngkir::currency()

成本

使用语法 RajaOngkir::cost($origin, $destination, $courier, $weight)，提供字符串 $origin、$destination、$courier 和总重量整数 $weight

国际成本

使用语法 RajaOngkir::internationalCost($origin, $destination, $courier, $weight)，提供字符串 $origin、$destination、$courier 和总重量整数 $weight

运单

使用 Waybill 方法，您可以根据收据号码跟踪您的运输状态。使用语法 RajaOngkir::waybill($waybill, $courier) 提供您的收据号码和快递公司。

国际目的地

使用 internationalDestination 方法获取国际航运目的地国家的列表/名称。使用语法 RajaOngkir::internationalDestination($id)，其中字符串参数为 $id

国际来源

使用 internationalOrigin 方法获取支持国际航运的城市列表/名称。使用语法 RajaOngkir::internationalOrigin($id, $province)，其中字符串参数为 $id 和 $province

测试

测试是用 phpunit 编写的。

在运行测试命令之前，请在包根目录中提供一个与 .env.example 内容相同的 .env.testing 文件。

您可以使用以下命令从项目目录的根目录运行测试。

vendor/bin/phpunit

许可

Laravel RajaOngkir 包是开源软件，根据 GNU LGPL 许可证版本 3 许可。