Parameter API untuk Verifikasi Sekarang
Parameter berikut perlu dikirim saat menggunakan API VerifyNow.
RCS/SAUTH
URL Dasar API Rest
Semua titik akhir API Platform di bawah ini harus diawali dengan URL berikut:
https://cpaas.messagecentral.com
Menghasilkan Token
Saat menggunakan API verifikasi SMS Verify Now untuk mengirim kode verifikasi SMS, panggilan awal harus ke API pembuatan token.
API ini mengembalikan token yang harus disertakan dalam semua panggilan berikutnya. Token otentikasi diperlukan untuk memvalidasi pengguna dan harus dimasukkan dalam bagian header dari setiap permintaan.
Meminta Jalur URL:
/auth/v1/authentication/token
cURL
1curl --location 'https://cpaas.messagecentral.com/auth/v1/authentication/token?
2customerId=%3CCustomerId%3E&key=%3CBase64%20Encrypted%20password%3E&scope=NEW&country=91
3&email=test%40messagecentral.com' \
4--header 'accept: */*'
CATATAN: Untuk mengubah perintah cURL menjadi kode menggunakan Postman, buka Postman, impor perintah cURL melalui tombol “Impor”, lalu buat kode dalam bahasa pilihan Anda dengan mengklik tombol “Kode” di sisi kanan permintaan.
Tanggapan JSON
1{
2 "status": Integer,
3 "token": "String"
4}
Raih Kesempatan
Jika Anda seorang pengembang atau agen pengembangan web, bermitra dengan kami untuk mempercepat penghasilan Anda.
Menjadi MitraKirim OTP
Untuk SendOTP pada nomor ponsel di bawah ini adalah parameter permintaan. Token otentikasi diperlukan untuk mengirim OTP yang dihasilkan oleh token API yang dihasilkan (yang dapat Anda temukan di atas di bagian Pendahuluan).
Meminta Jalur URL:
Respons yang berhasil akan mengembalikan kode status 200.
/verification/v3/send
Parameter URL Minta:
cURL
1curl --location --request POST 'https://cpaas.messagecentral.com/verification/v3/send?
2countryCode=91&flowType=SMS&mobileNumber=9999999999' \
3--header 'authToken:
4eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJDLTMzNDMyQTVGNDIGNzQwNCI6ImIhdCI6MTcxMjExOTA0MCwiZXhwIjo'
CATATAN: Untuk mengubah perintah cURL menjadi kode menggunakan Postman, buka Postman, impor perintah cURL melalui tombol “Impor”, lalu buat kode dalam bahasa pilihan Anda dengan mengklik tombol “Kode” di sisi kanan permintaan. Anda dapat mengubah basis FlowType saluran pilihan Anda.
Tanggapan JSON
1{
2 "responseCode": 200,
3 "message": "SUCCESS",
4 "data": {
5 "verificationId": "xxxx",
6 "mobileNumber": "xxxx",
7 "responseCode": "200",
8 "errorMessage": null,
9 "timeout": "60",
10 "smCLI": null,
11 "transactionId": "xxxx"
12 }
13}
Validasi OTP
Metode validateOTP adalah titik akhir REST API untuk memvalidasi kata sandi satu kali (OTP) untuk pelanggan.
Meminta Jalur URL:
Respons yang berhasil akan mengembalikan kode status 200.
/verification/v3/validateOtp/
- For multiple language support
- by default is English
- For now we support English only
cURL
1curl --location 'https://cpaas.messagecentral.com/verification/v3/validateOtp?
2&verificationId=2949&code=1476' \
3--header 'authToken:
4eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJDLTMzNDMyQTVGNDIGNzQwNCI6ImIhdCI6MTcxMjExOTA0MC'
CATATAN: Untuk mengubah perintah cURL menjadi kode menggunakan Postman, buka Postman, impor perintah cURL melalui tombol “Impor”, lalu buat kode dalam bahasa pilihan Anda dengan mengklik tombol “Kode” di sisi kanan permintaan.
Tanggapan JSON
Respons yang berhasil akan mengembalikan kode status 200.
1{
2 "responseCode": 200,
3 "message": "SUCCESS",
4 "data": {
5 "verficationId": "xxxx",
6 "mobileNumber": "xxxx",
7 "responseCode": "200",
8 "errorMessage": null,
9 "verificationStatus": "VERIFICATION_COMPLETED",
10 "authToken": null,
11 "transactionId": "xxxx"
12 }
13}
Kode Respon
Bantuan dan Dukungan
Untuk dukungan implementasi dan umpan balik apa pun, silakan hubungi kami di: support@messagecentral.com
Pertanyaan yang Sering Diajukan
1. Bagaimana saya bisa mengimplementasikan dengan kode khusus?
Anda dapat menggunakan postman untuk menulis ulang panggilan API dalam bahasa pemrograman pilihan Anda. Anda harus menggunakan: -
- Metode POST untuk mengirim SMS
- Metode GET untuk memvalidasi SMS OTP
2. Mengapa saya mendapatkan kesalahan “Metode tidak diizinkan” atau kode kesalahan 405?
Anda perlu memastikan bahwa URL titik akhir untuk API Token cocok dengan yang ditentukan dalam dokumentasi.Hal yang sama telah disebutkan di bawah ini: -
a. Token API menggunakan metode GET
b. Kirim API menggunakan metode POST
c. Validasi API menggunakan metode GET
3. Bagaimana cara menguji API verifikasi SMS?
Anda dapat menggunakan Postman untuk menguji API verifikasi SMS Message Central.
4. Mengapa saya mendapatkan halaman “Whitelabel Error”?
Jika Anda mendapatkan halaman Kesalahan Whitelabel, Anda harus memeriksa kesalahan berikut:
a. Anda menggunakan paket API yang salah
b. Anda belum mengganti placeholder dengan nilai aktual
c. API curl salah
d. Lokasi keriting belum diubah menjadi 'produksi' alih-alih 'pementasan'
5. Mengapa saya mendapatkan kode kesalahan 401?
Ini bisa jadi karena API atau token yang salah. Pastikan Anda telah mengikuti dokumentasi API kami untuk nilai token yang tepat.
6. Mengapa saya mendapatkan kode kesalahan 400 atau “Permintaan Buruk” di Postman?
Ada beberapa alasan untuk “Permintaan Buruk” di Postman. Anda dapat memeriksa kemungkinan alasan berikut: -
a. Periksa apakah AuthToken benar
b. Periksa apakah ada parameter yang hilang di API
c. Header harus diteruskan dalam format ini - application-x-www-form-urlencoded
7. Bagaimana cara menghasilkan AuthToken?
Untuk menghasilkan AuthToken di Postman, Anda harus: -
a. Temukan 'kunci' di GET API
b. Anda perlu menyalin kunci itu dan menyandikan yang sama menggunakan Base64 - https://www.base64encode.org/
c. Masukkan kata sandi yang dikodekan di placeholder 'Key'
d. Tekan GET API
Anda akan mendapatkan AuthToken.
8. Di mana saya menggunakan AuthToken?
Anda harus meletakkan AuthToken di header SEND API.
9. Apa semua parameter yang perlu saya ubah di GET API untuk menghasilkan token?
Anda perlu mengubah negara, ID pelanggan, email, dan kunci. Lingkup akan selalu tetap = “BARU”
10. Apa semua parameter yang perlu saya ubah di SEND API?
Anda perlu mengubah kode negara, id pelanggan, otplength, dan nomor ponsel.