Mengambil kode otorisasi untuk mengakses informasi pengguna.
Ikhtisar
wv.getAuthCode meminta izin kepada pengguna untuk memberikan akses informasi kepada program mini saat ini melalui tooltip. Disarankan untuk memanggil wv.getAuthCode setelah pengguna memahami konten bisnis program mini. Hindari pemanggilan wv.getAuthCode di layar beranda program mini demi menjaga pengalaman pengguna.
Kode otorisasi yang diperoleh dari pemanggilan wv.getAuthCode harus digunakan oleh server program mini untuk mendapatkan informasi pengguna seperti ID pengguna, avatar, nama panggilan, nomor telepon, wilayah, jenis kelamin, dan tanggal lahir.
Parameter permintaan
Parameter permintaan bertipe Object. Tabel berikut menjelaskan parameter tersebut.
Parameter | Tipe | Diperlukan | Deskripsi |
scopes | Array | Tidak | Ruang lingkup otorisasi. Bidang auth_base dan auth_user didukung. Untuk informasi lebih lanjut, lihat bagian "deskripsi scopes" dari topik ini. Nilai default: auth_base. |
success | Fungsi | Tidak | Fungsi callback untuk pemanggilan yang berhasil. |
fail | Fungsi | Tidak | Fungsi callback untuk pemanggilan yang gagal. |
deskripsi scopes
Scope menunjukkan ruang lingkup izin yang diminta pengembang kepada pengguna.
Scopes | Deskripsi | Apa yang Harus Dilakukan Selanjutnya |
USER_ID | Pengembang dapat memperoleh pengenal unik (user_id) dari pengguna aplikasi. Tidak ada tooltip yang ditampilkan selama proses otorisasi. | Teruskan kode otorisasi yang diperoleh oleh program mini ke server untuk mendapatkan ID pengguna. |
USER_NICKNAME | Pengembang dapat memperoleh nama panggilan pengguna aplikasi. | Teruskan kode otorisasi yang diperoleh oleh program mini ke server untuk mendapatkan informasi pengguna yang diizinkan. |
USER_NAME | Pengembang dapat memperoleh nama pengguna aplikasi. | Teruskan kode otorisasi yang diperoleh oleh program mini ke server untuk mendapatkan informasi pengguna yang diizinkan. |
USER_LOGIN_ID | Pengembang dapat memperoleh ID masuk pengguna aplikasi. | Teruskan kode otorisasi yang diperoleh oleh program mini ke server untuk mendapatkan informasi pengguna yang diizinkan. |
HASH_LOGIN_ID | Pengembang dapat memperoleh nilai hash dari ID masuk pengguna aplikasi. | Teruskan kode otorisasi yang diperoleh oleh program mini ke server untuk mendapatkan informasi pengguna yang diizinkan. |
USER_AVATAR | Pengembang dapat memperoleh avatar pengguna aplikasi. | Teruskan kode otorisasi yang diperoleh oleh program mini ke server untuk mendapatkan informasi pengguna yang diizinkan. |
USER_GENDER | Pengembang dapat memperoleh jenis kelamin pengguna aplikasi. | Teruskan kode otorisasi yang diperoleh oleh program mini ke server untuk mendapatkan informasi pengguna yang diizinkan. |
USER_BIRTHDAY | Pengembang dapat memperoleh tanggal lahir pengguna aplikasi. | Teruskan kode otorisasi yang diperoleh oleh program mini ke server untuk mendapatkan informasi pengguna yang diizinkan. |
USER_NATIONALITY | Pengembang dapat memperoleh kewarganegaraan pengguna aplikasi. | Teruskan kode otorisasi yang diperoleh oleh program mini ke server untuk mendapatkan informasi pengguna yang diizinkan. |
USER_CONTACTINFO | Pengembang dapat memperoleh informasi kontak pengguna aplikasi. | Teruskan kode otorisasi yang diperoleh oleh program mini ke server untuk mendapatkan informasi pengguna yang diizinkan. |
auth_base | Pengembang dapat memperoleh ID pengguna aplikasi. Tidak ada tooltip yang ditampilkan selama proses otorisasi. | Teruskan kode otorisasi yang diperoleh oleh program mini ke server untuk mendapatkan ID pengguna. |
auth_user | Pengembang dapat memperoleh informasi akun aplikasi. | Teruskan kode otorisasi yang diperoleh oleh program mini ke server untuk mendapatkan informasi pengguna yang diizinkan. |
Parameter respons
Fungsi callback sukses menerima objek dengan properti berikut.
Properti | Tipe | Deskripsi |
authCode | String | Kode otorisasi. |
authErrorScopes | Object | Ruang lingkup otorisasi yang gagal. Kunci adalah ruang lingkup otorisasi yang gagal, dan nilainya adalah kode kesalahan yang sesuai. |
authSuccessScopes | Array | Ruang lingkup otorisasi yang berhasil. |
Kode otorisasi baru dihasilkan untuk setiap otorisasi pengguna.
Fungsi callback gagal menerima objek bertipe Object, di mana bidang error menunjukkan kode kesalahan dan bidang errorMessage menunjukkan pesan kesalahan.
Kode kesalahan | Pesan kesalahan | Solusi |
11 | Pengguna membatalkan otorisasi | Jelaskan tujuan dan kebutuhan untuk mendapatkan informasi pengguna, dan pandu operasi lagi. |
12 | Kesalahan Jaringan | Permintaan jaringan terkait otorisasi gagal atau habis waktu. Coba lagi nanti. |
13 | Hasil otorisasi tidak ditemukan | Parameter scopes yang ditentukan tidak valid. Periksa parameter scopes. |
Kode contoh
window.WindVane.call('wv', 'getAuthCode', {scopes: ['auth_user']}, function(res) {
authCode = res.authCode;
}, function(e) {
alert('kegagalan:' + JSON.stringify(e));
});