Laravel Nusa

https://nusa.creasi.dev
Admin
Laravel Nusa is a ready-to-use Laravel package providing complete Indonesian administrative data...
Tokens:1,180
Snippets:16
Trust Score:4.8
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Laravel Nusa Package

Source: https://nusa.creasi.dev/

Install the package via Composer to begin using it in your Laravel application.

```bash
composer require creasi/laravel-nusa
```

--------------------------------

### Get All Provinces

Source: https://nusa.creasi.dev/

Retrieves a list of all Indonesian provinces available in the system.

```APIDOC
## GET /nusa/provinces

### Description
Retrieves a list of all Indonesian provinces.

### Method
GET

### Endpoint
/nusa/provinces
```

--------------------------------

### Get Regencies in a Province

Source: https://nusa.creasi.dev/

Retrieves a list of regencies within a specified province.

```APIDOC
## GET /nusa/provinces/{province_code}/regencies

### Description
Retrieves a list of regencies belonging to a specific province.

### Method
GET

### Endpoint
/nusa/provinces/{province_code}/regencies

### Parameters
#### Path Parameters
- **province_code** (string) - Required - The official code of the province (e.g., "33")
```

--------------------------------

### Get Specific Province

Source: https://nusa.creasi.dev/

Retrieves details for a specific Indonesian province using its code.

```APIDOC
## GET /nusa/provinces/{code}

### Description
Retrieves details for a specific province using its official code.

### Method
GET

### Endpoint
/nusa/provinces/{code}

### Parameters
#### Path Parameters
- **code** (string) - Required - The official code of the province (e.g., "33")
```

--------------------------------

### Address Management Integration

Source: https://nusa.creasi.dev/

Integrate address functionality into your Eloquent models using the `HasAddresses` contract and `WithAddresses` concern. This allows models to manage associated address data.

```php
use Creasi\Nusa\Contracts\HasAddresses;
use Creasi\Nusa\Models\Concerns\WithAddresses;

class User extends Model implements HasAddresses
{
    use WithAddresses;
}

// Now your users can have addresses
$user->addresses()->create([
    'province_code' => '33',
    'regency_code' => '33.75',
    'district_code' => '33.75.01',
    'village_code' => '33.75.01.1002',
    'address_line' => 'Jl. Merdeka No. 123'
]);
```

--------------------------------

### Search Villages

Source: https://nusa.creasi.dev/

Searches for villages based on name and/or codes, with support for pagination.

```APIDOC
## GET /nusa/villages

### Description
Searches for villages with support for filtering by name and codes. Supports pagination.

### Method
GET

### Endpoint
/nusa/villages

### Parameters
#### Query Parameters
- **search** (string) - Optional - The search term for village names.
- **codes[]** (string) - Optional - An array of village codes to filter by (e.g., "31.71.01.1001").
```

--------------------------------

### Basic Province Data Retrieval

Source: https://nusa.creasi.dev/

Retrieve all provinces or search for a specific province by name or code using Eloquent models. Related data (regencies, districts, villages) can be accessed through model relationships.

```php
use Creasi\Nusa\Models\Province;

// Get all provinces
$provinces = Province::all();

// Search by name or code
$jateng = Province::search('Jawa Tengah')->first();
$jateng = Province::search('33')->first();

// Get related data
$regencies = $jateng->regencies;
$districts = $jateng->districts;
$villages = $jateng->villages;
```

--------------------------------

### API Endpoints for Administrative Data

Source: https://nusa.creasi.dev/

Access administrative data through RESTful API endpoints. Supports fetching all data, specific entries by ID, related data, and searching with query parameters.

```http
# Get all provinces
GET /nusa/provinces

# Get specific province
GET /nusa/provinces/33

# Get regencies in a province
GET /nusa/provinces/33/regencies

# Search with query parameters
GET /nusa/villages?search=jakarta&codes[]=31.71
```
Tokens:
Raw