API Access
API Access memungkinkan administrator membuat token public API read-only untuk sistem eksternal yang membutuhkan data KartuStok.
Gunakan API Access saat sistem tepercaya lain perlu membaca company metadata, item, warehouse, category, atau data stock report dari KartuStok.
Lokasi Menu dan Akses
Buka Manage -> Integrations -> API Access.
| Aksi | Permission |
|---|---|
| Melihat token API | apiAccessView |
| Generate token | apiAccessCreate |
| Revoke token | apiAccessRevoke |
List Token
List menampilkan:
| Kolom | Arti |
|---|---|
| Name | Label token untuk integrasi. |
| Prefix | Bagian awal token untuk identifikasi di kemudian hari. |
| Scopes | Scope data yang diberikan ke token. |
| Status | Active atau inactive. |
| Last Used | Waktu terakhir token dipakai, jika tersedia. |
| Expires | Tanggal expiry, jika diisi. |
| Revoke | Aksi untuk menonaktifkan token aktif. |
Create API Access
| Field | Arti |
|---|---|
| Name | Nama integrasi, wajib diisi. |
| Expires At | Tanggal expiry opsional. Jika kosong, token tidak memiliki expiry date yang dikonfigurasi. |
| Scopes | Minimal satu scope harus dipilih. Scope tersedia mencakup company metadata, items, warehouses, item categories, dan stock reports. |
| Allowed IPs | IP allowlist opsional. Nilai bisa ditulis per baris atau dipisahkan koma. |
Setelah memilih Generate Token, KartuStok menampilkan token lengkap satu kali di card Copy Token Now. Simpan token dengan aman. Setelah itu list hanya menampilkan token prefix, bukan token lengkap.
Penting: Token lengkap hanya ditampilkan satu kali. Jika tidak langsung disalin dan disimpan, buat token baru.
Contoh Endpoint di Halaman
Halaman menampilkan contoh public API base URL berdasarkan origin browser aktif dan contoh request /public/v1/items dengan bearer token header.
Contoh Operasional: Integrasi Reporting
| Langkah | Aksi | Alasan |
|---|---|---|
| 1 | Buat token dengan nama integrasi, misalnya BI Dashboard. | Token lebih mudah diaudit nanti. |
| 2 | Pilih hanya scope read yang dibutuhkan integrasi. | Membatasi data yang terbuka. |
| 3 | Isi Expires At jika integrasi sementara. | Menghindari akses lama yang terlupakan. |
| 4 | Isi Allowed IPs jika integrasi punya IP server stabil. | Mengurangi risiko penyalahgunaan token. |
| 5 | Copy token segera. | Token lengkap hanya ditampilkan sekali. |
Buat token terpisah untuk setiap integrasi. Jangan memakai satu token untuk beberapa sistem yang tidak berkaitan.
Masalah Umum
| Masalah | Perbaikan |
|---|---|
| Token hilang setelah dibuat | Ini normal; token lengkap hanya tampil sekali. Buat token baru jika belum disimpan. |
| Sistem eksternal mendapat unauthorized | Cek token, status aktif, expiry date, dan scopes. |
| Token tidak boleh dipakai lagi | Gunakan Revoke di list token. |
Praktik Keamanan
- Buat satu token untuk satu integrasi.
- Berikan scope hanya sesuai kebutuhan integrasi.
- Gunakan Allowed IPs jika integrasi berjalan dari alamat server yang stabil.
- Revoke token yang tidak dipakai lagi.
- Simpan token lengkap langsung di sistem eksternal karena token hanya ditampilkan sekali.
Detail endpoint teknis dikelola terpisah dari user guide ini.