API_USER
API_USER adalah akun verifikasi yang digunakan untuk mengirim email di EngageLab.
Anda dapat mencari atau menambahkan API_USER menggunakan API.
Alamat Endpoint
| Data Center | URL |
|---|---|
| Singapura | https://email.api.engagelab.cc |
| Turki | https://emailapi-tr.engagelab.com |
Saat menggunakan REST API, pastikan data center yang dipilih sesuai dengan base URL yang benar.
POST /v1/api_users
Query (Batch)
Dapatkan informasi dasar tentang API_USER melalui endpoint ini.
URL
https://email.api.engagelab.cc/v1/api_users
Metode HTTP Request
GET
Header Permintaan
| Header | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| Authorization | String | ya | Basic base64(apiUser:apiKey) |
Deskripsi Parameter Query
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| email_type | int | tidak | tipe email: 0 (trigger), 1 (batch) |
| api_user_type | int | tidak | tipe api_user: 0 (uji coba), 1 (umum) |
| domain_name | string | tidak | nama domain yang terikat |
Contoh Permintaan
curl "https://email.api.engagelab.cc/v1/api_users" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Deskripsi Nilai Balik
| Field | Deskripsi |
|---|---|
| api_user | Nama API_USER |
| api_user_type | tipe api_user: 0 (uji coba), 1 (umum) |
| email_type | tipe email API_USER |
| domain_name | domain yang terikat dengan API_USER |
| click_tracking | pelacakan klik: false (nonaktif), true (aktif) |
| open_tracking | pelacakan terbuka: false (nonaktif), true (aktif) |
| unsubscribe_tracking | pelacakan berhenti berlangganan: false (nonaktif), true (aktif) |
Tambah
API_USER dan API_KEY adalah kredensial autentikasi untuk memanggil API EngageLab, mendukung pembedaan antara email trigger dan batch.
API ini memungkinkan Anda menambahkan API_USER dan mengembalikan API_KEY yang sesuai.
Catatan: Sebelum menambahkan API_USER melalui API ini, pastikan Anda sudah membuat API_USER dan API_KEY. Jika belum, login ke backend web untuk membuatnya pertama kali.
URL
https://email.api.engagelab.cc/v1/api_users
Content-Type:
application/json; charset=utf-8
Metode HTTP Request
POST
Header Permintaan
| Header | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| Authorization | String | ya | Basic base64(api_user:api_key) |
Deskripsi Parameter Body
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| api_user | string | ya | Nama API_USER |
| email_type | int | ya | tipe email: 0 (trigger), 1 (batch) |
| domain_name | string | ya | Nama domain yang terikat dengan API_USER |
| track_domain_name | string | tidak | Nama domain pelacakan yang terikat dengan API_USER |
| open_tracking | boolean | tidak | pelacakan terbuka: false (nonaktif), true (aktif); default nonaktif |
| click_tracking | boolean | tidak | pelacakan klik: false (nonaktif), true (aktif); default nonaktif |
| unsubscribe_tracking | boolean | tidak | pelacakan berhenti berlangganan: false (nonaktif), true (aktif); default aktif |
Tips:
- Untuk pelacakan berhenti berlangganan, sistem akan memaksa aktif untuk pengguna gratis.
Contoh Permintaan
curl -X POST "https://email.api.engagelab.cc/v1/api_users"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"api_user":"batch_edm",
"email_type":1,
"domain_name":"aizl.net"
}'
Deskripsi Nilai Balik
| Field | Deskripsi |
|---|---|
| api_user | Nama API_USER |
| api_key | API_KEY |
| api_user_type | Tipe API_USER |
| email_type | Tipe email API_USER |
| domain_name | Domain yang terikat dengan API_USER |
| click_tracking | Status pelacakan klik |
| open_tracking | Status pelacakan terbuka |
| unsubscribe_tracking | Status pelacakan berhenti berlangganan |
Jika gagal, contoh respons error:
{
"code": 31110,
"message": "api_user tidak boleh kosong."
}
