An open API service indexing awesome lists of open source software.

https://github.com/didikz/laravel-rajaongkir

Rajaongkir API Wrapper for Laravel
https://github.com/didikz/laravel-rajaongkir

laravel php7 rajaongkir rajaongkir-api

Last synced: 2 months ago
JSON representation

Rajaongkir API Wrapper for Laravel

Awesome Lists containing this project

README

        

# Laravel Rajaongkir

[![Latest Stable Version](https://poser.pugx.org/didikz/laravel-rajaongkir/v)](//packagist.org/packages/didikz/laravel-rajaongkir) [![Total Downloads](https://poser.pugx.org/didikz/laravel-rajaongkir/downloads)](//packagist.org/packages/didikz/laravel-rajaongkir) [![Latest Unstable Version](https://poser.pugx.org/didikz/laravel-rajaongkir/v/unstable)](//packagist.org/packages/didikz/laravel-rajaongkir) [![License](https://poser.pugx.org/didikz/laravel-rajaongkir/license)](//packagist.org/packages/didikz/laravel-rajaongkir)

![alt text](https://banners.beyondco.de/Laravel%20Rajaongkir.png?theme=light&packageName=didikz%2Flaravel-rajaongkir&pattern=ticTacToe&style=style_1&description=Rajaongkir+API+simple+wrapper+for+Laravel&md=1&fontSize=100px&images=truck "Laravel RajaOngkir Logo")

## Installation

You can install the package via composer:

```bash
composer require didikz/laravel-rajaongkir
```

You can publish the config file with:
```bash
php artisan vendor:publish --provider="Didikz\LaravelRajaongkir\LaravelRajaongkirServiceProvider" --tag="config"
```

Add api key to your `.env` file:

```bash
RAJAONGKIR_API_KEY=apikeyfromrajaongkir
```

## Usage

### Get All Provinces
``` php
use Didikz\LaravelRajaOngkir\Location;

$location = new Location(config('laravel-rajaongkir.api_key');
$location->province();

// or using facade
use Didikz\LaravelRajaongkir\Facade\Location;

$provinces = Location::province();
```

### Get Province by Id
``` php
use Didikz\LaravelRajaOngkir\Location;

$location = new Location(config('laravel-rajaongkir.api_key');
$province = $location->province(1);

// or using facade
use Didikz\LaravelRajaongkir\Facade\Location;

$province = Location::province(1);
```

### Get All Cities by Province Id
``` php
use Didikz\LaravelRajaOngkir\Location;

$provinceId = 1;
$location = new Location(config('laravel-rajaongkir.api_key');
$cities = $location->city($provinceId);

// or using facade
use Didikz\LaravelRajaongkir\Facade\Location;

$provinceId = 1;
$cities = Location::city($provinceId);
```

### Get city
``` php
use Didikz\LaravelRajaOngkir\Location;

$provinceId = 6;
$cityId = 152;
$location = new Location(config('laravel-rajaongkir.api_key');
$city = $location->city($provinceId, $cityId);

// or using facade
use Didikz\LaravelRajaongkir\Facade\Location;

$provinceId = 6;
$cityId = 152;
$city = Location::city($provinceId, $cityId);
```

### Calculate Cost

Check [Available Couriers](https://rajaongkir.com/dokumentasi#daftar-kurir) based on their plan

``` php
use Didikz\LaravelRajaOngkir\Cost;

$cost = new Cost(config('laravel-rajaongkir.api_key');
$cost->destination(152)->origin(155)->weight(2000)->courier('jne')->calculate();

// or using facade
use Didikz\LaravelRajaOngkir\Facade\Cost;

$cost = Cost::destination(152)->origin(155)->weight(2000)->courier('jne')->calculate();
```

## Testing

``` bash
./vendor/bin/phpunit
```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [Didik Tri S](https://github.com/didikz)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.