Zona Kerja Logo
LoginCoba Gratis
Dokumentasi

Manajemen API Keys

Kategori: Api Keys · Aplikasi: admin-panel

Gambaran Umum

Fitur API Keys memungkinkan integrasi Zona Kerja dengan sistem eksternal (sistem ERP, payroll eksternal, dll.) menggunakan autentikasi berbasis token yang aman.

Mengakses API Keys

Klik "API Keys" di sidebar kiri

Kapan Menggunakan API Keys?

API Keys digunakan ketika:

  • Mengintegrasikan Zona Kerja dengan sistem ERP perusahaan (SAP, Oracle, Odoo)
  • Membangun dashboard kustom yang mengambil data dari Zona Kerja
  • Automasi proses HR menggunakan skrip atau tools pihak ketiga
  • Integrasi dengan sistem absensi hardware (fingerprint, face recognition)

Melihat Daftar API Keys

Tabel menampilkan semua API key yang sudah dibuat:

Kolom Keterangan
Nama Nama deskriptif untuk API key
Prefix Awalan key untuk identifikasi (key penuh hanya tampil sekali)
Dibuat Pada Tanggal pembuatan
Terakhir Digunakan Kapan terakhir key ini dipakai
Status Aktif / Nonaktif
Aksi Hapus

Membuat API Key Baru

  1. Klik "+ Buat API Key"
  2. Isi Nama untuk key ini (contoh: "Integrasi ERP Odoo", "Dashboard Kustom")
  3. Klik "Buat"
  4. PENTING: API Key akan ditampilkan hanya sekali setelah dibuat

Menyimpan API Key

Setelah membuat API key:

  1. Salin key secara lengkap menggunakan tombol "Salin"
  2. Simpan di tempat yang aman (password manager, vault, dll.)
  3. Klik "Saya sudah menyalin key ini" untuk menutup dialog

⚠️ Peringatan: API Key tidak dapat dilihat kembali setelah dialog ini ditutup. Jika lupa, buat key baru.

Menggunakan API Key

API Key digunakan sebagai header Authorization dalam setiap request API:

Authorization: Bearer {api_key}

Contoh dengan curl:

curl -H "Authorization: Bearer hrm_xxxxxxxxxxxx" \
  https://api.hrmate.id/v1/employees

Menghapus API Key

Jika key tidak lagi diperlukan atau dicurigai bocor:

  1. Klik ikon "Hapus" pada baris API key
  2. Konfirmasi penghapusan

Penghapusan bersifat permanen. Semua integrasi yang menggunakan key ini akan berhenti bekerja.

Praktik Keamanan API Key

  • Jangan simpan API key di kode sumber yang dapat dilihat publik (GitHub, dll.)
  • Gunakan environment variables untuk menyimpan key di aplikasi
  • Buat key terpisah untuk setiap integrasi
  • Rotasi key secara berkala (buat key baru, update integrasi, hapus key lama)
  • Segera hapus key yang dicurigai bocor atau tidak lagi digunakan
  • Batasi hak akses API sesuai kebutuhan minimum (principle of least privilege)

Dokumentasi API

Untuk dokumentasi lengkap endpoint API yang tersedia, lihat file: documentation/ → 02_Zona Kerja_API_Contract.md

Atau hubungi tim Zona Kerja untuk akses dokumentasi API terbaru.