Validasi OTP
Endpoint
POST https://otp.api.engagelab.cc/v1/verifications
Autentikasi
Gunakan Autentikasi Dasar HTTP untuk autentikasi, lalu sertakan Authorization pada header HTTP:
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
Tampilkan blok kode ini di jendela mengambang
base64_auth_string dibuat sebagai berikut: base64(dev_key:dev_secret)
Contoh Permintaan
Header Permintaan
POST /v1/verifications HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
POST /v1/verifications HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
Tampilkan blok kode ini di jendela mengambang
Body Permintaan
{
"message_id": "1725407449772531712",
"verify_code": "667090"
}
{
"message_id": "1725407449772531712",
"verify_code": "667090"
}
Tampilkan blok kode ini di jendela mengambang
Parameter Permintaan
| Parameter | Type | Required | Description |
|---|---|---|---|
| message_id | String | Required | ID pesan yang sesuai dengan kode verifikasi, yang dikembalikan oleh API /messages |
| verify_code | String | Required | Kode verifikasi yang akan divalidasi |
Parameter Respons
Respons Berhasil
| Field | Type | Required | Description |
|---|---|---|---|
| message_id | String | Required | ID pesan yang sesuai dengan kode verifikasi, yang dikembalikan oleh API /v1/messages |
| verify_code | String | Required | Kode verifikasi yang akan divalidasi |
| verified | Boolean | Required | Hasil validasi. true menunjukkan validasi berhasil, sedangkan false menunjukkan validasi gagal |
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
Tampilkan blok kode ini di jendela mengambang
Catatan: Jika permintaan validasi dibuat untuk kode verifikasi dari pesan yang sama dan kode tersebut berhasil divalidasi, setiap permintaan berikutnya ke API validasi ini akan gagal dan mengembalikan pesan yang menyatakan bahwa kode verifikasi untuk pesan tersebut sudah divalidasi. Dengan kata lain, kode verifikasi yang telah berhasil divalidasi tidak dapat divalidasi kembali.
Respons Gagal
Kode status HTTP adalah 4xx atau 5xx, dan body respons berisi field berikut:
| Field | Type | Required | Description |
|---|---|---|---|
| code | int | Required | Kode kesalahan. Untuk detailnya, lihat Kode Kesalahan |
| message | String | Required | Detail kesalahan |
{
"code": 3003,
"message": "verify code has expired"
}
{
"code": 3003,
"message": "verify code has expired"
}
Tampilkan blok kode ini di jendela mengambang
Kode Kesalahan
| Error Code | HTTP Code | Description |
|---|---|---|
| 1000 | 500 | Kesalahan internal |
| 2001 | 401 | Autentikasi gagal: token yang benar tidak diberikan |
| 2002 | 401 | Autentikasi gagal: token telah kedaluwarsa atau dinonaktifkan |
| 2004 | 403 | Tidak memiliki izin untuk memanggil API ini |
| 3001 | 400 | Format parameter permintaan tidak valid. Harap periksa apakah konten JSON sudah sesuai dengan format parameter yang diperlukan |
| 3002 | 400 | Parameter permintaan tidak valid. Harap periksa apakah parameter permintaan memenuhi persyaratan |
| 3003 | 400 | Kode verifikasi telah kedaluwarsa atau sudah diverifikasi. Untuk respons dengan kode kesalahan ini, pesan kode verifikasi baru harus dikirim |
| 3011 | 400 | Kode verifikasi kedaluwarsa |
| 4001 | 400 | Pesan tidak ditemukan |
