novay/laravel-api-samarinda

该包旨在帮助本地开发者方便地使用 Samarinda 市政府提供的 API。

1.1 2021-07-24 12:22 UTC

This package is auto-updated.

Last update: 2024-09-24 19:44:27 UTC


README

Total Downloads Build Status Latest Stable Version Latest Unstable Version License

该包旨在帮助本地开发者,特别是 Samarinda 的程序员,方便地使用 Samarinda 市政府提供的 API。

关于

为了满足本地开发者的数据需求,Samarinda 市政府创建了一个 Laravel 包,以帮助本地开发者,特别是 Samarinda 的程序员,方便地使用市政府提供的 API。

要求

安装

Laravel 5.5 及以上
  1. 通过终端(Linux & Mac)或 Command Prompt(Windows)运行以下命令:
    composer require novay/laravel-api-samarinda
  • 该包使用 auto discovery 功能。
Laravel 5.4 以下(可选,用于 Laravel 5.5)
  1. config/app.php 文件中相应的 providersaliases 位置添加以下行:
'providers' => [
    Novay\ApiSamarinda\ApiSamarindaServiceProvider::class, 
];

'aliases' => [
    'ApiSamarinda' => Novay\ApiSamarinda\Facade::class, 
];
配置
  1. 运行以下命令:
php artisan vendor:publish --provider="Novay\ApiSamarinda\ApiSamarindaServiceProvider"
  1. 将以下设置添加到您的 .env 文件中:
# Samarinda API Settings, SMR_TOKEN are required.
SMR_API='http://api.samarindakota.go.id/api'
SMR_API_VERSION='v1'
SMR_TOKEN='API_KEY_ANDA'
  1. http://api.samarindakota.go.id 创建账户并获取您的 TOKEN

用户指南

先说这么多。

# DEVELOPER RESMI

// Untuk menampilkan seluruh data penduduk di Kota Samarinda. Note: 15 Penduduk per Page
return ApiSamarinda::penduduk();
// Untuk menampilkan data Penduduk berdasarkan NIK (Khusus KTP Samarinda)
return ApiSamarinda::pendudukByNik(6403050611910002);


# DEVELOPER BIASA

// Untuk melakukan pemanggilan menggunakan URL lengkap
return ApiSamarinda::url('GET', 'http://api.samarindakota.go.id/api/v1/sekolah?with=both&jenjang=smk', true);

// Menampilkan seluruh data provinsi di Indonesia
return ApiSamarinda::provinsi();
// Menampilkan data provinsi per paginasi (Tentukan sendiri berapa yang mau ditampilkan per Halaman)
return ApiSamarinda::provinsi(15);
// Menampilkan data provinsi berdasarkan ID (List ID Provinsi segera dibuatkan halaman khusus)
return ApiSamarinda::provinsiById($id_provinsi);
// Melakukan pencarian provinsi berdasarkan kata kunci, dalam hal ini adalah "nama"
return ApiSamarinda::provinsiByNama('kalimantan timur');

// Penjelasan sama dengan provinsi
return ApiSamarinda::kota();
return ApiSamarinda::kota(15);
return ApiSamarinda::kotaById(1103);
return ApiSamarinda::kotaByNama('samarinda');
// Menampilkan seluruh Kota yang ada di Provinsi sesuai dengan ID Provinsi yang ditentukan
return ApiSamarinda::kotaByIdProvinsi(64);

// Penjelasan sama dengan Provinsi dan Kota
return ApiSamarinda::kecamatan();
return ApiSamarinda::kecamatan(15);
return ApiSamarinda::kecamatanById(1101030);
return ApiSamarinda::kecamatanByNama('redeb');
return ApiSamarinda::kecamatanByIdKota(6472);

// Penjelasan sama dengan Provinsi, Kota dan Kecamatan
return ApiSamarinda::kelurahan();
return ApiSamarinda::kelurahan(15);
return ApiSamarinda::kelurahanById(1101010007);
return ApiSamarinda::kelurahanByNama('redeb');
return ApiSamarinda::kelurahanByIdKecamatan(6405060);

// Menampilkan seluruh data sekolah yang ada di Kota Samarinda (Data diambil langsung dari Dapodik)
return ApiSamarinda::sekolah();

// Berhubung nama kecamatan dan kelurahan ditampilkan dalam bentuk Kode, 
// gunakan parameter berikut untuk menampilkan kecamatan dan kelurahan dalam bentuk nama.
// 1. 'kecamatan' untuk menampilkan nama kecamatannya 
// 2. 'kelurahan' untuk menampilkan nama kelurahannya
// 3. 'both' untuk menampilkan keduanya
return ApiSamarinda::sekolah('kecamatan');
return ApiSamarinda::sekolah('kelurahan');
return ApiSamarinda::sekolah('both');

// Menampilkan seluruh data sekolah di Kota Samarinda berdasarkan jenjang pendidikannya
return ApiSamarinda::sekolahByJenjang('sd');
return ApiSamarinda::sekolahByJenjang('smp');
return ApiSamarinda::sekolahByJenjang('sma');
return ApiSamarinda::sekolahByJenjang('smk');

// Menampilkan seluruh data sekolah di Kota Samarinda berdasarkan status sekolah
return ApiSamarinda::sekolahByStatus('swasta');
return ApiSamarinda::sekolahByStatus('negeri');

// Menampilkan seluruh data sekolah di Kota Samarinda yang berlokasi di Kelurahan tertentu 
// Silahkan gunakan ID Kelurahan yang diinginkan
return ApiSamarinda::sekolahByKelurahan(6472030002);

// Menampilkan seluruh data sekolah di Kota Samarinda yang berlokasi di Kecamatan tertentu
// Silahkan gunakan ID Kecamatan yang diinginkan
return ApiSamarinda::sekolahByKecamatan(6472022);



// Contoh implementasi pada data yang ditarik menggunakan salah satu function diatas

// Untuk yang sifatnya List atau Array gunakan ini:
$data = ApiSamarinda::provinsi();
$array = (array)$data->original;
foreach($array['data'] as $temp) {
	return $temp['name'];
	// Output: Aceh
}

// Untuk yang sifatnya Individual atau Object gunakan ini:
$data = ApiSamarinda::provinsiById(64);
$array = (array)$data->original;
return $array['data']['name'];
// Output: Kalimantan Timur

致谢

许可证

Samarinda API(应用程序编程接口)在 MIT 许可证下授权,适用于个人和商业产品。祝您享受!