All Products
Search

This Product

    SuperApp:wv.getAuthCode

    Document Center

    SuperApp:wv.getAuthCode

    Last Updated:Apr 23, 2026

    Meminta otorisasi pengguna dan mengembalikan kode otorisasi (authCode).

    Ikhtisar

    Metode wv.getAuthCode menampilkan pop-up otorisasi untuk meminta izin pengguna agar miniapp dapat mengakses informasi mereka. Untuk pengalaman pengguna yang optimal, panggil metode ini hanya ketika pengguna memahami alasan permintaan otorisasi tersebut. Hindari memanggil wv.getAuthCode pada layar awal miniapp.

    Kode otorisasi (authCode) yang dikembalikan menandakan persetujuan pengguna. Server miniapp Anda kemudian harus menggunakan kode ini untuk mendapatkan informasi pengguna dari platform, seperti user_id, avatar, nickname, nomor ponsel, wilayah, jenis kelamin, dan tanggal lahir.

    Parameter permintaan

    Sebuah objek dengan parameter berikut:

    Parameter

    Type

    Required

    Description

    scopes

    Array

    No

    Array cakupan otorisasi. Untuk daftar nilai yang valid, lihat bagian scopes di bawah. Nilai default-nya adalah ['auth_base'].

    success

    Function

    No

    Fungsi callback yang dijalankan saat berhasil.

    fail

    Function

    No

    Fungsi callback yang dijalankan saat gagal.

    Scopes

    Scope menentukan izin yang diminta oleh miniapp Anda dari pengguna.

    Scope

    Description

    Server action

    USER_ID

    Deprecated. Scope ini merupakan alias untuk auth_base.

    Lihat auth_base.

    USER_NICKNAME

    Mengizinkan miniapp untuk mendapatkan nickname pengguna.

    Kirimkan authCode ke server Anda untuk mengambil informasi pengguna yang telah diotorisasi.

    USER_NAME

    Mengizinkan miniapp untuk mendapatkan nama pengguna.

    Kirimkan authCode ke server Anda untuk mengambil informasi pengguna yang telah diotorisasi.

    USER_LOGIN_ID

    Mengizinkan miniapp untuk mendapatkan ID login pengguna.

    Kirimkan authCode ke server Anda untuk mengambil informasi pengguna yang telah diotorisasi.

    HASH_LOGIN_ID

    Mengizinkan miniapp untuk mendapatkan nilai hash dari ID login pengguna.

    Kirimkan authCode ke server Anda untuk mengambil informasi pengguna yang telah diotorisasi.

    USER_AVATAR

    Mengizinkan miniapp untuk mendapatkan avatar pengguna.

    Kirimkan authCode ke server Anda untuk mengambil informasi pengguna yang telah diotorisasi.

    USER_GENDER

    Mengizinkan miniapp untuk mendapatkan jenis kelamin pengguna.

    Kirimkan authCode ke server Anda untuk mengambil informasi pengguna yang telah diotorisasi.

    USER_BIRTHDAY

    Mengizinkan miniapp untuk mendapatkan tanggal lahir pengguna.

    Kirimkan authCode ke server Anda untuk mengambil informasi pengguna yang telah diotorisasi.

    USER_NATIONALITY

    Mengizinkan miniapp untuk mendapatkan kewarganegaraan pengguna.

    Kirimkan authCode ke server Anda untuk mengambil informasi pengguna yang telah diotorisasi.

    USER_CONTACTINFO

    Mengizinkan miniapp untuk mendapatkan informasi kontak pengguna.

    Kirimkan authCode ke server Anda untuk mengambil informasi pengguna yang telah diotorisasi.

    auth_base

    Mengizinkan miniapp untuk mendapatkan identifier unik pengguna (user_id). Ini merupakan otorisasi diam (silent authorization) dan tidak menampilkan pop-up otorisasi.

    Kirimkan authCode ke server Anda untuk mengambil identifier unik pengguna (user_id).

    auth_user

    Mengizinkan miniapp untuk mendapatkan informasi akun pengguna.

    Kirimkan authCode ke server Anda untuk mengambil informasi pengguna yang telah diotorisasi.

    Parameter respons

    Fungsi callback success menerima sebuah objek dengan properti-properti berikut:

    Property

    Type

    Description

    authCode

    String

    Kode otorisasi.

    authErrorScopes

    Object

    Objek yang memetakan scope yang gagal ke kode kesalahan yang sesuai.

    authSuccessScopes

    Array

    Array scope yang berhasil diotorisasi.

    Catatan

    authCode baru dihasilkan setiap kali pengguna memberikan otorisasi.

    Fungsi callback fail menerima sebuah objek dengan properti error (kode kesalahan) dan properti errorMessage (pesan kesalahan).

    Error code

    Error message

    Solution

    11

    User canceled authorization

    Jelaskan kepada pengguna mengapa informasi mereka diperlukan dan pandu mereka untuk mencoba lagi.

    12

    Network error

    Permintaan otorisasi gagal atau timeout. Coba lagi nanti.

    13

    No authorization result found

    Parameter scopes berisi nilai yang tidak valid. Pastikan nilainya berupa array scope yang valid.

    Kode contoh

    window.WindVane.call('wv', 'getAuthCode', {scopes: ['auth_user']}, function(res) {
		authCode = res.authCode;
}, function(e) {
    alert('failure:' + JSON.stringify(e));
});