unipo / siakad-sdk
SDK resmi API SIAKAD UNIPO untuk PHP 8.1+: token OAuth2 otomatis, 2.000+ endpoint bertipe, PSR-18, integrasi Laravel.
Requires
- php: ^8.1
- ext-json: *
- guzzlehttp/guzzle: ^7.5
- guzzlehttp/psr7: ^2.4
- psr/http-client: ^1.0
- psr/http-factory: ^1.0
- psr/simple-cache: ^1.0 || ^2.0 || ^3.0
Requires (Dev)
- phpstan/phpstan: ^1.12
- phpunit/phpunit: ^10.5 || ^11.0
Suggests
- laravel/framework: Service provider, facade Siakad, dan cache token otomatis (^10, ^11, ^12)
Provides
None
Conflicts
None
Replaces
None
- dev-main / 1.x-dev
- v1.18.0
- v1.17.0
- v1.16.0
- v1.15.0
- v1.14.0
- v1.13.0
- v1.12.1
- v1.12.0
- v1.11.0
- v1.10.0
- v1.9.0
- v1.8.0
- v1.7.0
- v1.6.0
- v1.5.0
- v1.4.0
- v1.3.1
- v1.3.0
- v1.2.0
- v1.1.0
- v1.0.0
- dev-claude/project-thread-asy9g9-npm-oidc
- dev-claude/project-thread-rspgpe
- dev-claude/project-thread-nhiodv
- dev-claude/project-thread-4cnlmj
- dev-claude/project-thread-hka966
- dev-claude/project-thread-tbwqjg
- dev-claude/project-thread-j2tv8l
- dev-claude/project-thread-2wqlun
- dev-claude/project-thread-c7s892
- dev-claude/project-thread-uovxjl
- dev-claude/project-thread-sto2sg
- dev-claude/project-thread-0nnpb7
- dev-claude/project-thread-16jm91
- dev-claude/project-thread-3wws02
- dev-otomatis/perbarui-spec
- dev-claude/project-thread-l92mq7
- dev-claude/project-thread-fan8h1
- dev-claude/project-thread-avmtsj
This package is auto-updated.
Last update: 2026-11-18 06:05:31 UTC
README
SDK resmi API SIAKAD UNIPO untuk PHP dan Node.js. Kedua paket punya perilaku yang sama.
| Bahasa | Paket | Pasang | Panduan |
|---|---|---|---|
| PHP 8.1–8.5 (Laravel, Symfony, CodeIgniter, PHP biasa) | unipo/siakad-sdk |
composer require unipo/siakad-sdk |
php/README.md |
| Node.js 18.17+, Bun, Deno (Next.js, NestJS, Express, ...) | unipo-siakad-sdk |
npm install unipo-siakad-sdk |
node/README.md |
- Token OAuth 2.0 otomatis: token aplikasi diminta, disimpan, dan diperbarui sendiri; login pengguna, tukar token SSO, refresh otomatis, revoke, lupa/reset password.
- 40 modul dengan 2.008 endpoint (MODUL.md), bertipe dan berdokumentasi di autocomplete editor.
- Galat bertipe dengan
requestId, percobaan ulang 429/502/503/504, iterasi halaman, unggah/unduh file. methodOverrideuntuk hosting yang menolak PUT/PATCH/DELETE,environment: developmentuntuk database development.
$siakad = new \Unipo\Siakad\Siakad(['client_id' => '...', 'client_secret' => '...']); echo $siakad->mahasiswa()->getByNim('2025001')['nama'];
import { Siakad } from 'unipo-siakad-sdk'; const siakad = new Siakad({ clientId: '...', clientSecret: '...' }); const { data } = await siakad.mahasiswa.getByNim('2025001');
Kredensial didapat dari portal pengembang api.unipo.ac.id. Panduan singkat juga ada di api.unipo.ac.id/docs/panduan/sdk.
Struktur repo
composer.json, phpunit.xml.dist, phpstan.neon.dist paket PHP (Packagist membaca composer.json di akar)
php/
├── src/Siakad.php, Options.php, Auth/, Http/, Exceptions/, Pagination/, Laravel/ ditulis tangan
├── src/Resources/, src/Concerns/GeneratedResources.php, src/Laravel/Facades/ hasil generator
├── config/siakad.php config Laravel
└── tests/ PHPUnit (HTTP tiruan) + integrasi.php (API sungguhan)
node/ paket npm (TypeScript, tsup → ESM + CJS)
├── src/core.ts, auth.ts, errors.ts, types.ts, token-store.ts ditulis tangan
├── src/generated/ hasil generator
└── test/ node:test (fetch tiruan) + integrasi.mjs (API sungguhan)
generator/generate.mjs menulis kode modul PHP + TypeScript dari openapi.json
generator/spec-dari-siakad.php membuat openapi.json dari kode SIAKAD
openapi.json spesifikasi API SIAKAD
Arsip Composer hanya berisi paket PHP (.gitattributes membuang node/, generator/, dan berkas uji).
Pengembangan
composer install && composer test && composer analyse (cd node && npm install && npm run typecheck && npm run build && npm test)
Memperbarui setelah endpoint SIAKAD bertambah
curl -s https://api.unipo.ac.id/v1/openapi.json > openapi.json # atau dari kode SIAKAD: php generator/spec-dari-siakad.php /path/ke/siakad_unipo > openapi.json node generator/generate.mjs
Workflow Perbarui spesifikasi API (.github/workflows/perbarui-spec.yml) menjalankan langkah di atas tiap jam
(juga lewat tombol dan repository_dispatch bertipe siakad-api-berubah), jadi endpoint baru SIAKAD masuk SDK tanpa
langkah manual:
- Sumber spesifikasi: kode SIAKAD di branch
main(lewatspec-dari-siakad.php) bila secretSIAKAD_REPO_TOKENdiisi (fine-grained token, izin Contents: Read padaanasamu/siakad_unipo). Tanpa secret,GET /v1/openapi.jsondi server (variabel repoSIAKAD_OPENAPI_URL, bawaanhttps://api.unipo.ac.id/v1/openapi.json), yang baru berubah setelah server diperbarui. - Hanya ada operasi baru atau perubahan skema: versi dinaikkan (minor/patch), CHANGELOG ditulis, diuji (Node.js + PHP),
di-commit ke
main, lalu workflow Rilis dijalankan. npm, Packagist, dan GitHub Release terbit sendiri. - Ada operasi yang hilang (metode SDK terhapus): tidak dirilis otomatis. Perubahan ditaruh di branch
otomatis/perbarui-specdan dibuka PR versi mayor; bila Actions tidak boleh membuat PR, dibuat issue berisi tautannya. - Variabel repo
SPEC_OTOMATIS=prmembuat semua perubahan lewat PR.
Endpoint yang baru muncul dan belum masuk SDK tetap bisa dipanggil dengan siakad.request({ method, path }) (Node.js)
atau $siakad->request($metode, $path) (PHP).
CI gagal bila kode hasil generator tidak sesuai openapi.json. Nama metode diturunkan dari operationId; menghapus
atau mengganti path endpoint berarti menghapus metode, jadi naikkan versi mayor.
Uji ke API sungguhan
Butuh API SIAKAD lokal/development dan klien dengan scope referensi:read portal:read portal:write portal:admin
serta izin login pengguna. Skrip membuat data uji di portal; jangan dijalankan ke database live.
export SIAKAD_URL=http://127.0.0.1:8090/api SIAKAD_CLIENT_ID=cli_... SIAKAD_CLIENT_SECRET=... SIAKAD_USER=... SIAKAD_PASS=... php php/tests/integrasi.php (cd node && npm run build && node test/integrasi.mjs)
Rilis
Rilis berjalan otomatis lewat .github/workflows/rilis.yml. Versi PHP dan Node.js selalu sama.
- Otomatis setiap merge PR ke
main. Versi dinaikkan sendiri lalu dirilis: diuji (generator, PHPUnit, paket npm), diberi tag, diterbitkan ke npm, dan dibuatkan GitHub Release. Packagist membaca tag itu sendiri. Judul PR menjadi catatan di CHANGELOG.- Jenis kenaikan: label PR
rilis:major,rilis:minor, ataurilis:patch. Tanpa label, ditebak dariopenapi.json: ada operasi hilang = major, ada operasi baru = minor, selain itu patch. - Bila PR sudah menaikkan versi sendiri (mis. PR otomatis dari perbarui-spec), versi itu yang dirilis.
- Tidak dirilis bila PR berlabel
rilis:tidak, atau isi paket (php/,node/src,openapi.json,composer.json) tidak berubah sejak rilis terakhir, mis. hanya README atau workflow.
- Jenis kenaikan: label PR
- Tombol. Actions > Rilis > Run workflow, pilih
patch,minor, ataumajor. Versi dinaikkan di semua berkas, di-commit kemain, lalu dirilis. - Naikkan versi di PR. Jalankan skrip ini agar semua berkas versi dan CHANGELOG berubah bersamaan:
node generator/versi.mjs minor --catatan "Metode baru ..." # patch | minor | major | X.Y.Z | tetap node generator/versi.mjs # tampilkan versi sekarang
Cara lama tetap bisa: git tag vX.Y.Z && git push origin vX.Y.Z (versi berkas harus sama dengan tag).
Bila main dilindungi aturan branch, izinkan GitHub Actions mem-push ke main: kenaikan versi otomatis di-commit
ke main sebelum diberi tag.
Persiapan sekali
Packagist (repo ini harus publik): masuk packagist.org dengan akun GitHub, Submit,
isi https://github.com/anasamu/unipo-sdk. Integrasi GitHub Packagist memasang webhook, jadi tag berikutnya terbaca
otomatis.
npm:
npm login cd node && npm install && npm run build && npm publish --access public # terbitan pertama npm token create # token untuk rilis otomatis gh secret set NPM_TOKEN -R anasamu/unipo-sdk
Lisensi
MIT. Dikelola Pustikom Universitas Pohuwato.