Pengantar
Ambil informasi tentang akun administrator, peran, dan izin mereka.
Untuk informasi lebih lanjut tentang antarmuka pengguna modul ini, kunjungi https://doc.oneentry.cloud/docs/category/administrators
🎯 Apa yang dilakukan modul ini?
Modul Admins bersifat hanya-baca: ia mengambil akun administrator dari proyek OneEntry Anda dan nilai atribut mereka, dengan penyaringan opsional. Membuat akun, menetapkan peran, dan mencabut akses semuanya dilakukan di panel admin OneEntry — modul SDK ini hanya membaca informasi tersebut sehingga aplikasi Anda dapat melihat siapa yang memiliki akses dan apa yang dapat mereka lakukan.
🚀 Memulai dengan Cepat
Inisialisasi modul dari defineOneEntry:
const { Admins } = defineOneEntry( "your-project-url", { "token": "your-app-token" });
Ambil admin, dengan penyaringan opsional berdasarkan kondisi atribut:
// Filter body: admins whose "num" attribute is greater than 1.
const body = [
{ attributeMarker: "num", conditionMarker: "mth", conditionValue: 1 },
];
// getAdminsInfo(body, langCode, offset, limit) — all optional except defaults.
const admins = await Admins.getAdminsInfo(body, "en_US", 0, 30);
admins.forEach((admin) => {
console.log(admin.id, admin.identifier);
});
Kirim array kosong ([]) untuk body ketika Anda tidak memerlukan penyaringan.
✨ Konsep Kunci
Apa itu Administrator?
Seorang administrator (admin) adalah akun dengan akses yang lebih tinggi untuk mengelola proyek OneEntry Anda. Setiap admin memiliki:
- Identifikasi - pengidentifikasi unik admin
- Set atribut - set atribut yang dimiliki admin (
attributeSetIdentifier) - Nilai atribut - bidang yang dikonfigurasi (
attributeValues) - Peran / izin - dikonfigurasi di panel admin; SDK membacanya melalui nilai atribut
Administrator vs Pengguna Reguler
| Tipe | Tujuan | Contoh |
|---|---|---|
| Administrator | Mengelola sistem (backend) | Anda, anggota tim Anda |
| Pengguna Reguler | Menggunakan aplikasi/website Anda (frontend) | Pelanggan Anda, pengunjung situs web |
Admins mengelola konten; Users mengkonsumsi konten.
📋 Apa yang Perlu Anda Ketahui
Atribut admin
Setiap objek admin memiliki bidang kunci ini:
{
id: 123, // Unique admin ID
attributeSetId: 27, // Attribute set ID
identifier: "admin", // Unique identifier
attributeSetIdentifier: "admins", // Attribute set identifier
position: 1, // Position
isSync: true, // Whether synced with the backend
attributeValues: {} // Attribute values
}
Menyaring admin
Saring melalui body permintaan — sebuah array kondisi, masing-masing menggabungkan attributeMarker, conditionMarker, dan conditionValue (penanda yang sama seperti pada modul Products):
| Marker | Arti | Contoh |
|---|---|---|
| eq | Sama | statusId = 1 (hanya aktif) |
| neq | Tidak sama | role ≠ "Viewer" |
| in | Mengandung (salah satu) | role in ["Editor", "Manager"] |
| nin | Tidak mengandung | email not in ["@temp.com"] |
| mth | Lebih dari (lebih besar) | createdYear > 2020 |
| lth | Kurang dari | loginCount < 5 |
| exs | Ada (memiliki nilai) | Memiliki lastLogin |
| nexs | Tidak ada | Tidak pernah login |
📊 Tabel Referensi Cepat
| Metode | Deskripsi |
|---|---|
| getAdminsInfo() | Ambil akun admin, dengan penyaringan opsional |
Parameter
const body = [ { "attributeMarker": "num", "conditionMarker": "mth", "conditionValue": 1 }];
const response = await Admins.getAdminsInfo(body, "en_US", 0, 30);
Skema: (body)
attributeMarker: string
Pengidentifikasi atribut teks
contoh: price
conditionMarker: string
Pengidentifikasi kondisi teks, nilai yang mungkin: 'in' - mengandung, 'nin' - tidak mengandung, 'eq' - sama, 'neq' - tidak sama, 'mth' - lebih dari, 'lth' - kurang dari, 'exs' - ada, 'nexs' - tidak ada
contoh: in
Enum: [ in, nin, eq, neq, mth, lth, exs, nexs ]
conditionValue: number
Nilai kondisi
contoh: 1
❓ Pertanyaan Umum (FAQ)
Apa perbedaan antara modul Admins dan Users?
- Admins - akun tim backend yang mengelola sistem (hanya-baca di sini).
- Users - akun frontend yang menggunakan aplikasi/website Anda (modul Users).
Bisakah saya membuat atau mengedit admin dengan modul ini?
Tidak. Modul Admins bersifat hanya-baca. Buat akun, tetapkan peran dan izin, dan cabut akses di panel admin OneEntry.
🎓 Praktik Terbaik
- Jangan pernah mengekspos kredensial admin atau token istimewa di kode frontend.
- Gunakan filter untuk mengambil hanya admin yang Anda butuhkan daripada daftar lengkap.
- Terapkan prinsip hak akses minimum saat mengonfigurasi peran di panel admin.
🔗 Dokumentasi Terkait
- Modul Users - Mengelola akun pengguna frontend
- Modul AttributesSets - Set atribut di balik bidang admin
- Panel Admin OneEntry - Administrator - Dokumentasi resmi panel admin