Skip to content

Commit

Permalink
Update Dokumentasi
Browse files Browse the repository at this point in the history
  • Loading branch information
black-coffee04 committed Jun 27, 2024
1 parent 685b03b commit 7bb0725
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 10 deletions.
66 changes: 61 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,13 @@ Selamat datang di SiASN Web Service SDK! SDK ini dirancang untuk memudahkan peng
- [Detail Konfigurasi](#detail-konfigurasi)
- [Dokumentasi API](#dokumentasi-api)
- [Authentication](#authentication)
- [Contoh Penggunaan Authentication](#contoh-penggunaan-authentication)
- [Referensi](#referensi)
- [Contoh Penggunaan Referensi](#contoh-penggunaan-referensi)
- [PNS](#pns)
- [Contoh Penggunaan Api PNS](#contoh-penggunaan-api-pns)
- [Jabatan](#jabatan)
- [Contoh Penggunaan Api jabatan](#contoh-penggunaan-api-jabatan)
- [Dokumen](#dokumen)
- [Contoh Penggunaan Api dokumen](#contoh-penggunaan-api-dokumen)
- [Pemberhentian](#pemberhentiaan)
- [Pengadaan](#pengadaan)
- [Kenaikan Pangkat](#kenaikan-pangkat)
- [Menjalankan Tes](#menjalankan-tes)
- [Lisensi](#lisensi)

Expand Down Expand Up @@ -320,6 +318,7 @@ $riwayatJabatanId = $siasnClient->jabatan()
### Dokumen

Berikut adalah daftar lengkap metode yang tersedia pada resource dokumen:

| Metode | Deskripsi | Parameter | Kembalian |
|---------------------------------------------|-------------------------------------------------------------|----------------------------------------------------------------|---------------------------------------------------------------|
| `$siasnClient->dokumen()->download($args)->setName($fileName)->outputStream()` | Mengambil dokumen pada siasn dan langsung menampilkan tanpa disimpan pada local server. | `$args` >(json), (array), (object): respon upload file pada siasn >(string) $dokUri, `$fileName` (string): Nama file | Menghasilkan output stream foto profil ASN. |
Expand All @@ -345,6 +344,63 @@ echo $siasnClient->dokumen()->download($response)->setName($fileName)->saveTo($p
$siasnClient->dokumen()->download($response)->setName($fileName)->outputStream();
```

### Pemberhentiaan

Berikut adalah daftar lengkap metode yang tersedia pada resource pemberhentian:

| Metode | Deskripsi | Parameter | Kembalian |
|---------------------------------------------|-------------------------------------------------------------|----------------------------------------------------------------|---------------------------------------------------------------|
| `$siasnClient->pemberhentian()->get($tanggalAwal, $tanggalAkhir)` | Mengambil semua data pensiun instansi berdasarkan periode tanggal. | `$tanggalAwal` (string): Tanggal Awal, `$tanggalAkhir` (string): Tanggal Akhir | Array data pemberhentian Instansi.

#### Contoh Penggunaan Api Pemberhentian

Anda dapat mengolala dokumen menggunakan SDK SiASN:

```php
$tanggalAwal = '2022-01-01';
$tanggalAkhir = '2022-12-01';

$daftarPemberhentian = $siasnClient->pemberhentian()->get($tanggalAwal, $tanggalAkhir);
```

### Pengadaan

Berikut adalah daftar lengkap metode yang tersedia pada resource pengadaan:

| Metode | Deskripsi | Parameter | Kembalian |
|---------------------------------------------|-------------------------------------------------------------|----------------------------------------------------------------|---------------------------------------------------------------|
| `$siasnClient->pengadaan()->get($tahun)` | Mengambil semua data pengadaan instansi berdasarkan tahun pengadaan. | `$tahun` (string): Tanggal Awal | Array data pengadaan Instansi.
| `$siasnClient->pengadaan()->dokumen()` | Mengambil semua data dokumen pengadaan instansi. | - | Array data dokumen pengadaan Instansi.

#### Contoh Penggunaan Api pengadaan

Anda dapat mengolala dokumen menggunakan SDK SiASN:

```php
$tahunAnggaran = '2023';

$daftarPengadaan = $siasnClient->pengadaan()->get($tahunAnggaran);
$dokumenPengadaan = $siasnClient->pengadaan()->dokumen();
```

### Kenaikan Pangkat

Berikut adalah daftar lengkap metode yang tersedia pada resource kp:

| Metode | Deskripsi | Parameter | Kembalian |
|---------------------------------------------|-------------------------------------------------------------|----------------------------------------------------------------|---------------------------------------------------------------|
| `$siasnClient->kp()->get($tanggalAwal, $tanggalAkhir)` | Mengambil semua data kenaikan pangkat instansi berdasarkan periode kp. | `$periode` (string): Periode KP | Array data KP Instansi.

#### Contoh Penggunaan Api Kenaikan Pangkat

Anda dapat mengolala dokumen menggunakan SDK SiASN:

```php
$periode = '2022-04-01';

$daftarKp = $siasnClient->kp()->get($periode);
```

## Menjalankan Tes

Untuk menjalankan tes pada SDK ini, pastikan Anda telah menginstal dependensi dengan Composer dan konfigurasi yang diperlukan seperti yang dijelaskan sebelumnya.
Expand Down
5 changes: 0 additions & 5 deletions examples/pemberhentian.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,7 @@
$siasnClient = new SiasnClient($config);
$tanggalAwal = '2022-01-01';
$tanggalAkhir = '2022-12-01';
// $periode = '2023-04-01';
// $tahunAnggaran = '2023';

$daftarPemberhentian = $siasnClient->pemberhentian()->get($tanggalAwal, $tanggalAkhir);
// $daftarKenaikanPangkat = $siasnClient->instansi()->kenaikanPangkat($periode);
// $daftarPengadaan = $siasnClient->instansi()->pengadaan($tahunAnggaran);
// $dokumenPengadaan = $siasnClient->instansi()->dokumen($tahunAnggaran);

var_dump($daftarPemberhentian);

0 comments on commit 7bb0725

Please sign in to comment.