Skip to main content
Buat akun layanan dan kunci API di Developer Hub, lalu kirim permintaan pertama Anda. Panduan cepat ini menggunakan autentikasi kunci API; Anda tidak memerlukan klien OAuth. Lihat Autentikasi jika integrasi Anda memerlukan token akses OAuth berumur pendek.

Prasyarat

  • Akses admin ke Dasbor Living Security.
  • Developer Hub yang terlihat di bawah Pengaturan → Integrasi & Developers → Developer Hub.

Membuat kredensial

1

Buat akun layanan

Di Developer Hub, buka tab Service accounts lalu buat sebuah akun. Berikan nama yang deskriptif (misalnya reporting-pipeline) dan berikan izin yang dapat digunakan oleh kunci-kuncinya — untuk panduan ini, organization:read sudah cukup.Izin akun tersebut merupakan batas maksimum bagi setiap kunci yang dibuat di bawahnya: sebuah kunci tidak akan pernah dapat melakukan lebih dari yang diizinkan oleh akun layanannya.
2

Buat kunci API

Buka halaman detail akun layanan lalu buat sebuah kunci. Pilih izin yang dibutuhkan kunci ini secara spesifik (subset dari izin akun) serta masa berlaku — 30, 90, atau 365 hari, atau periode kustom. Masa berlaku wajib ditentukan.Rahasia kunci diawali dengan lsk_live_ dan ditampilkan sekali saja. Salin ke pengelola rahasia (secret manager) segera; rahasia tersebut tidak dapat diambil kembali nanti.
Jangan pernah meng-commit rahasia kunci API ke version control atau menyematkannya dalam kode sisi klien. Siapa pun yang memegang rahasia tersebut dapat bertindak dengan izin kunci tersebut.
3

Pilih region Anda

Panggil host /v1 regional yang sesuai dengan residensi data organisasi. Kunci hanya diautentikasi pada host tersebut.Lihat Region jika Anda tidak yakin host mana yang harus digunakan. Kunci yang valid yang dikirim ke region lain akan gagal dengan unauthorized. Gunakan dropdown region pada contoh di bawah untuk mengganti host.
4

Kirim permintaan pertama Anda

Muat LIVING_SECURITY_API_KEY dari pengelola rahasia Anda ke dalam environment proses yang mengirim permintaan. Contoh di bawah membacanya tanpa menyematkan rahasia dalam kode sumber. Untuk Python, instal requests terlebih dahulu.Panggil API dengan rahasia pada kolom kata sandi atau nama pengguna HTTP Basic auth — keduanya dapat digunakan, sehingga klien yang mengharuskan kedua kolom terisi (seperti konektor Web Power BI) dapat memasukkan placeholder seperti apikey pada kolom lainnya.
Respons yang berhasil akan mengembalikan organisasi Anda:
Response
Jika Anda menerima respons ini, kredensial Anda berfungsi. Permintaan tersebut juga muncul di tab Request logs Developer Hub dalam beberapa saat.
Autentikasi Bearer dengan rahasia yang sama (Authorization: Bearer lsk_live_...) juga dapat digunakan. Basic auth tersedia agar alat yang hanya mendukung nama pengguna/kata sandi — seperti konektor Web Power BI — dapat terhubung.

Cara kerja autentikasi

  • Kredensial menentukan organisasi. Permintaan /v1 tidak membawa pemilih tenant: tanpa segmen jalur organisasi dan tanpa header organisasi. Pengiriman header x-organization-id akan ditolak dengan invalid_request. Host tetap harus sesuai dengan region organisasi tersebut. Lihat Region.
  • Izin diperiksa per operasi. Setiap operasi /v1 memerlukan izin bernama (misalnya, GET /v1/organization memerlukan organization:read). Kunci yang tidak memiliki izin tersebut akan menerima 403 dengan kode insufficient_permission.
  • Kunci kedaluwarsa dan dapat dirotasi tanpa downtime. Lihat Kunci API untuk rotasi dengan periode tumpang tindih.

Membaca respons error

Setiap error /v1 berformat application/problem+json (RFC 9457) dengan kode mesin yang stabil. Misalnya, permintaan dengan kredensial yang hilang atau tidak dikenal mengembalikan:
401 Unauthorized
Lakukan percabangan berdasarkan code, jangan pernah berdasarkan detail. Ikuti doc_url untuk langkah penyelesaian, dan sertakan request_id saat menghubungi dukungan — nilai ini cocok dengan header respons Request-Id dan log permintaan Developer Hub. Kumpulan kode lengkap ada di referensi error.

Versi kontrak

Setiap respons menyertakan versi kontrak yang melayaninya pada header Living-Security-Version, bersama header Request-Id untuk korelasi. Anda dapat menyematkan permintaan ke versi kontrak yang dipublikasikan berdasarkan tanggal:
Versi ditentukan dengan urutan berikut: header permintaan jika ada, jika tidak default yang disematkan pada akun layanan, jika tidak versi terbaru yang dipublikasikan. Meminta versi yang tidak dipublikasikan (atau sudah melewati tanggal sunset-nya) mengembalikan 400 dengan kode unsupported_version. Versi yang dipublikasikan beserta perubahannya tercantum di changelog API.

Pemecahan masalah permintaan pertama Anda

Untuk error lainnya, ikuti doc_url pada respons. Simpan Request-Id untuk dukungan; jangan pernah menyertakan header Authorization atau kunci API Anda dalam tiket.

Langkah berikutnya

Region

Pilih host /v1 US atau EU untuk organisasi.

Paginasi

Telusuri daftar dengan page_token dan envelope daftar.

Batas laju

Pahami anggaran permintaan dan tangani respons 429.

Referensi error

Setiap kode error, status HTTP-nya, dan cara mengatasinya.

Developer Hub

Kelola akun layanan, kunci API, dan log permintaan.