API Validasi Hasil
Deskripsi
Server APP memanggil antarmuka ini untuk mengirim data terenkripsi (payload) yang dikembalikan oleh SDK Engagelab ke server Engagelab guna memverifikasi kecocokan nomor telepon.
Informasi Antarmuka
| Item | Deskripsi |
|---|---|
| Jalur permintaan | POST /v1/verify |
| Protokol | HTTPS |
| Autentikasi | HTTP Basic Auth |
| Content-Type | application/json |
Domain terbaru: authapi.engagelab.com
Contoh Permintaan
curl -X POST 'https://{authapi.engagelab.com}/v1/verify' \
-H 'Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl' \
-H 'Content-Type: application/json' \
-d '{
"payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..."
}'
curl -X POST 'https://{authapi.engagelab.com}/v1/verify' \
-H 'Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl' \
-H 'Content-Type: application/json' \
-d '{
"payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..."
}'
Tampilkan blok kode ini di jendela mengambang
Autentikasi
Gunakan HTTP Basic Auth untuk autentikasi:
Authorization: Basic base64(appKey:appSecret)
Authorization: Basic base64(appKey:appSecret)
Tampilkan blok kode ini di jendela mengambang
Contoh:
- appKey:
tn4nm0qx032yx6f17q2tsa8f - appSecret:
your_app_secret_here - pengodean base64:
dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl
Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl
Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl
Tampilkan blok kode ini di jendela mengambang
Parameter Permintaan
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| payload | string | Ya | Data terenkripsi yang dikembalikan oleh SDK Engagelab, diteruskan oleh APP |
Contoh body permintaan:
{
"payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..."
}
{
"payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..."
}
Tampilkan blok kode ini di jendela mengambang
Parameter Respons
Respons Berhasil (HTTP 200)
| Parameter | Tipe | Deskripsi |
|---|---|---|
| code | int | Kode status; 0 berarti berhasil |
| msg | string | Deskripsi status |
| data | object | Data respons |
| data.message_id | string | Pengidentifikasi pesan unik, dapat digunakan untuk pemecahan masalah |
| data.verified | boolean | Hasil verifikasi nomor; true berarti cocok, false berarti tidak cocok |
Contoh berhasil (verifikasi lolos):
{
"code": 0,
"msg": "success",
"data": {
"message_id": "1876123456789012345",
"verified": true
}
}
{
"code": 0,
"msg": "success",
"data": {
"message_id": "1876123456789012345",
"verified": true
}
}
Tampilkan blok kode ini di jendela mengambang
Contoh berhasil (verifikasi tidak lolos):
{
"code": 0,
"msg": "success",
"data": {
"message_id": "1876123456789012345",
"verified": false
}
}
{
"code": 0,
"msg": "success",
"data": {
"message_id": "1876123456789012345",
"verified": false
}
}
Tampilkan blok kode ini di jendela mengambang
Respons Kesalahan (HTTP 4xx/5xx)
| Parameter | Tipe | Deskripsi |
|---|---|---|
| code | int | Kode kesalahan |
| msg | string | Deskripsi kesalahan |
Contoh kesalahan:
{
"code": 2001,
"msg": "auth failed"
}
{
"code": 2001,
"msg": "auth failed"
}
Tampilkan blok kode ini di jendela mengambang
Kode Kesalahan
| Kode kesalahan | Kode status HTTP | Deskripsi | Saran penanganan |
|---|---|---|---|
| 1000 | 500 | Kesalahan internal server | Silakan coba lagi nanti; jika berlanjut, hubungi dukungan teknis |
| 2001 | 401 | Autentikasi gagal | Periksa apakah appKey dan appSecret sudah benar dan apakah format Authorization sesuai spesifikasi |
| 2004 | 401 | appKey tidak valid | Periksa apakah appKey sudah benar, atau hubungi dukungan teknis untuk memastikan layanan sudah diaktifkan |
| 3001 | 400 | Format parameter tidak valid | Periksa apakah body permintaan merupakan JSON yang valid |
| 3002 | 400 | Validasi parameter gagal | Periksa apakah parameter payload ada dan formatnya benar |
| 3003 | 400 | appKey tidak cocok | appKey pada payload tidak sesuai dengan appKey pada header autentikasi; pastikan Anda menggunakan pasangan kunci yang benar |
| 3004 | 400 | Konfigurasi belum diaktifkan | Konfigurasi layanan belum diaktifkan; silakan hubungi dukungan teknis untuk mengaktifkannya |
| 3005 | 400 | Saldo tidak mencukupi | Saldo akun tidak mencukupi; silakan isi ulang dan coba lagi |
| 4001 | 400 | Konfigurasi tidak ditemukan | Konfigurasi layanan yang sesuai tidak ditemukan; silakan hubungi dukungan teknis |
| 5001 | 400 | Verifikasi gagal | Terjadi pengecualian selama proses autentikasi operator; selidiki berdasarkan detail pada msg atau hubungi dukungan teknis |
Catatan
- Penerusan payload: Setelah APP menerima payload yang dikembalikan oleh SDK Engagelab, APP harus mengirimkannya apa adanya ke server APP, yang kemudian memanggil antarmuka ini. Jangan mengubah payload dengan cara apa pun.
- Saran keamanan: Simpan appSecret dengan aman dan gunakan hanya di sisi server; jangan mengeksposnya di dalam APP.
- Hasil verifikasi: Nilai
verifiedsebesarfalseberarti nomor telepon yang dimasukkan pengguna tidak cocok dengan nomor pada kartu SIM, dan login pengguna harus ditolak.










