API Autentikasi Pengguna

Sebelum mengambil data pengguna atau mengubah pengaturan melalui Vivoldi REST API, Anda perlu mendapatkan token akses untuk autentikasi.

Mekanisme autentikasi berbasis token dengan masa berlaku terbatas meningkatkan keamanan akun dan melindungi permintaan API dari ancaman eksternal.

Sertakan token dalam header X-Access-Token untuk melakukan pemanggilan API secara aman.

API ini tersedia mulai dari paket Personal ke atas.

POST

/api/user/v1/auth

{
    "eml": "your@gmail.com"
}

Request Parameters

eml string
Email.
Digunakan untuk melihat atau memperbarui informasi pengguna yang ditambahkan dalam organisasi pada paket Business atau lebih tinggi.
Diabaikan pada paket Personal dan Premium.
{
    "code": 0,
    "message": "",
    "result": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Response Parameters

code integer
Kode respons: 0 = Berhasil, nilai lainnya = Error
message string
Pesan respons. Jika kode bukan 0, pesan error akan dikembalikan.
result string
Saat meminta untuk melihat atau memperbarui informasi pengguna, Anda harus menyertakannya di header HTTP sebagai X-Access-Token.
Token ini berlaku selama 1 menit dan harus diterbitkan ulang (dengan memanggil API ini lagi) setelah kedaluwarsa.

Mengapa token autentikasi diperlukan

Semua permintaan API harus diautentikasi untuk memverifikasi identitas dan izin pengguna.

API ini memiliki fungsi berikut:

  • Mengidentifikasi pemanggil API
  • Memvalidasi izin pengguna
  • Memblokir permintaan yang tidak sah
  • Mengelola status sesi yang aman

Kapan menggunakan API ini

<p> API ini wajib digunakan sebelum mengakses endpoint terkait akun, seperti <a href="/url/api/user/retrieve">Retrieve User</a> atau <a href="/url/api/user/update">Update User</a>. </p> <p> Token yang diterbitkan harus disertakan dalam header HTTP sebagai <code>X-Access-Token</code> pada semua permintaan berikutnya. Masa berlaku yang singkat membantu menjaga keamanan sesi. </p>

Arti masa berlaku token 1 menit

Masa berlaku 1 menit adalah desain yang berfokus pada keamanan.
Jika token bocor, token akan otomatis kedaluwarsa dalam satu menit sehingga risiko dapat diminimalkan.

Implementasi yang disarankan adalah membuat token tepat sebelum pemanggilan API dan langsung menggunakannya.
Menyimpan token untuk digunakan kembali dapat menyebabkan kesalahan autentikasi.

Penentuan target dan syarat paket

Pada paket Business atau lebih tinggi, admin organisasi dapat melakukan autentikasi atas nama pengguna dengan mengisi email pada parameter eml.

Hal ini memungkinkan otomatisasi pengelolaan dan pengambilan data pengguna dalam organisasi.
API ini hanya tersedia untuk akun dengan paket Personal atau lebih tinggi, jadi pastikan paket Anda sesuai.

Hal yang perlu diperhatikan

  • Simpan token dengan aman dan pastikan tidak terekspos ke pihak luar
  • Hindari penggunaan token langsung di sisi client karena berisiko
  • Implementasikan mekanisme refresh otomatis saat token kedaluwarsa
  • Gunakan API hanya melalui HTTPS