Gunakan Workspace API untuk menghubungkan data workspace StaffAny yang dipilih ke alat eksternal secara aman, untuk keperluan pelaporan, otomasi, integrasi, dan alur kerja berbasis AI.

Panduan ini akan membahas hal berikut:

Workspace API adalah cara yang aman bagi pelanggan yang disetujui untuk mengizinkan alat lain membaca atau memperbarui data StaffAny yang dipilih. Fitur ini dirancang untuk tim yang ingin menghubungkan StaffAny dengan alat pelaporan, dasbor, sistem internal, otomasi, atau alat AI.

Akses API dibatasi pada akun StaffAny yang membuat API key. Artinya, API key hanya dapat mengakses data dan tindakan yang diizinkan untuk akun pengguna StaffAny tersebut.

Kasus penggunaan umum meliputi:

Workspace API diperbarui secara aktif. Jika kasus penggunaan Anda membutuhkan data atau tindakan yang belum tersedia saat ini, bagikan kasus tersebut kepada tim StaffAny agar kami dapat meninjau permintaan dan kelayakannya.

Read access saat ini gratis untuk semua organisasi StaffAny, sementara Write access merupakan fitur berbayar. Saat ini mencakup beberapa area workspace StaffAny, termasuk Identity, Groups, Sales, Scheduling, Staff, Wall, Leaves, Payroll, dan Compensations.

Jika Anda tidak yakin apakah kasus penggunaan Anda membutuhkan read access atau write access, mulailah dengan mendeskripsikan apa yang ingin Anda buat dan apakah alat eksternal perlu mengubah data di dalam StaffAny, dan kami akan memberikan saran yang sesuai.

Catatan: Akses data dibatasi oleh izin. Data dan tindakan yang dapat diakses oleh API key Anda bergantung pada tingkat izin akun StaffAny yang membuatnya. API key mewarisi hak akses yang sama dengan akun pengguna tersebut dan tidak memberikan akses lebih luas dari apa yang dapat dilihat atau dilakukan pengguna di dalam StaffAny.

Sebagai contoh:

Jika integrasi API mengembalikan data yang lebih sedikit dari yang diharapkan, pastikan akun StaffAny yang digunakan untuk membuat API key memiliki tingkat akses dan penetapan grup yang tepat untuk data yang Anda butuhkan.

Workspace API dapat digunakan bersama coding agent dan alat AI seperti Claude, Codex, atau alat serupa saat Anda ingin membuat laporan, menganalisis data, atau membuat prototipe alur kerja.

Tampilan pengaturan dan prompt mungkin berbeda antar alat, namun persyaratan StaffAny tetap sama: gunakan dokumentasi API terbaru dan Workspace API key milik Anda. Video di atas menampilkan seluruh alur pengaturan, dari awal hingga prompt.

Dokumentasi API adalah panduan bagi pengguna untuk memahami cara terhubung dengan Workspace API. Panduan ini menjelaskan data dan tindakan apa yang tersedia, permintaan apa yang harus dikirim, dan respons apa yang diharapkan. Gunakan dokumentasi API terbaru setiap kali Anda membuat atau memperbarui integrasi, laporan, otomasi, atau alur kerja berbasis AI. Dokumentasi Workspace API tersedia di https://api.staffany.com/docs.

Siapa pun yang memiliki akses ke aplikasi web StaffAny dapat membuat Workspace API key. Key tersebut menggunakan izin yang sama dengan akun StaffAny yang membuatnya.

Untuk membuat API key Anda, buka app.staffany.com, di bagian Pengaturan → Akun & Keamanan → Workspace API Keys. Dari sana, klik Generate Key untuk mendapatkan API key Anda. Perlu diingat bahwa key hanya akan ditampilkan sekali, jadi simpanlah dengan aman.

API key hanya akan ditampilkan sekali. Lihat video pengaturan di atas untuk cara terbaik menyimpan API key Anda.

Perlakukan API key Anda seperti kata sandi:

Bagaimana cara mendapatkan akses ke Workspace API?

Hubungi perwakilan StaffAny atau tim Dukungan Anda dengan kasus penggunaan yang dimaksud. StaffAny akan meninjau permintaan dan mengaktifkan akses jika disetujui.

Apakah Workspace API dapat memperbarui data StaffAny?

Ya, tetapi hanya untuk kasus penggunaan write yang telah disetujui. Write access diaktifkan secara terpisah dari read access dan mungkin dikenakan biaya.

Apakah Workspace API sepenuhnya mandiri (self-serve)?

Belum. Akses API harus diaktifkan terlebih dahulu untuk workspace Anda, dan kasus penggunaan write memerlukan tinjauan tambahan.

Apakah pengaturan Claude sama dengan pengaturan Codex?

Umumnya, ya. Keduanya memerlukan dokumentasi API StaffAny terbaru dan Workspace API key Anda. Langkah pengaturan yang tepat mungkin sedikit berbeda antar alat.

Saya tidak dapat mengganti nama file API key menjadi .env di Mac, muncul pesan peringatan.

Pesan tersebut muncul untuk mencegah penghapusan file tersembunyi yang penting secara tidak sengaja. File yang diawali dengan "." bersifat tersembunyi. Untuk "membuka" kemampuan ini, cukup tekan cmd+shift+. saat berada di dalam folder.

Apa yang harus saya lakukan jika tidak dapat mengakses data yang dibutuhkan?

Bagikan kasus bisnis tersebut kepada StaffAny. Tim dapat mengonfirmasi apakah data tersebut saat ini sudah didukung atau apakah permintaan tersebut perlu ditinjau untuk cakupan API di masa mendatang.

Apa yang harus saya lakukan saat Workspace API diperbarui?

Jika Workspace API diperbarui, unduh spesifikasi API atau materi referensi terbaru dari situs dokumentasi sebelum melanjutkan pengembangan. Ini membantu alat eksternal Anda menggunakan endpoint dan definisi data terbaru yang tersedia.

Siapa yang harus saya hubungi untuk mendapatkan bantuan?

Untuk pertanyaan terkait akses, penagihan, atau pengaturan umum, hubungi perwakilan StaffAny Anda. Untuk laporan atau integrasi yang kompleks, hubungi kami melalui chat bantuan dalam aplikasi.

Bagaimana cara mendapatkan write access ke API?

Hubungi perwakilan StaffAny atau tim Dukungan Anda dengan kasus penggunaan yang dimaksud. StaffAny akan membantu Anda lebih lanjut mengenai paket harga dan pengaktifan write access. Setelah diaktifkan, tidak ada perubahan yang perlu dilakukan dari sisi Anda!