logoDokumen
Email
Beranda Dokumen
Mulai CepatInstruksiREST APISMTPGunakan PemasaranWebHookSumber Daya
Cari
Bahasa Indonesia
English
繁體中文
简体中文
日本語
ภาษาไทย
Español
Bahasa Indonesia
Masuk
REST API / Domain Pelacakan

Domain Pelacakan

Terakhir diperbarui：2025-09-10

Kelola domain pelacakan Anda.

Alamat Panggilan

Pusat Data URL
Singapura https://email.api.engagelab.cc
Turki https://emailapi-tr.engagelab.com

Saat menggunakan REST API, pastikan pusat data yang dipilih sesuai dengan base URL yang tepat.

POST/v1/tracking-domains

Query

Dapatkan daftar domain pelacakan

URL

https://email.api.engagelab.cc/v1/tracking-domains
              
              https://email.api.engagelab.cc/v1/tracking-domains
Tampilkan blok kode ini di jendela mengambang

Metode Permintaan HTTP

GET
              
              GET
Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Header Tipe Wajib Deskripsi
Authorization String ya Basic base64(apiUser:apiKey)

Deskripsi Parameter Query

Parameter Tipe Wajib Deskripsi
name string tidak nama domain
offset int tidak offset, [0-], default 0
limit int tidak jumlah, [0-100], default 100

Contoh Permintaan

curl "https://email.api.engagelab.cc/v1/tracking-domains?name=engagelab.com" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl "https://email.api.engagelab.cc/v1/tracking-domains?name=engagelab.com" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balikan

Parameter Deskripsi
domain_id ID domain
name nama domain
cname detail record CNAME domain
verify status konfigurasi (true/false)
verify_message pesan status CNAME, null jika sudah benar
required_record record CNAME yang harus dikonfigurasi
existed_record record CNAME yang sudah ada
cert detail sertifikat domain
expired_date tanggal kedaluwarsa sertifikat
create_time waktu pembuatan domain
update_time waktu modifikasi domain

Contoh Nilai Balikan

Response-sukses

HTTP Status: 200

{ "result": [ { "domain_id": 1000403, "name": "track.leonww.asia", "create_time": "2025-04-18T13:27:38+0800", "update_time": "2025-09-04T12:32:56+0800", "cname": { "verify": true, "verify_message": "Konfigurasi berhasil", "required_record": "track01.engagelab.email", "existed_record": "track01.engagelab.email" }, "cert": { "verify": true, "verify_message": "sertifikat sudah aktif", "expired_date": "2025-12-02T07:59:59+0800" } }, { "domain_id": 1000402, "name": "track.myMail.com", "create_time": "2025-04-18T13:05:57+0800", "update_time": "2025-04-18T13:05:57+0800", "cname": { "verify": false, "verify_message": "Record cname belum dikonfigurasi", "required_record": "track01.engagelab.email", "existed_record": "" }, "cert": { "verify": false, "verify_message": "sertifikat belum diunggah", "expired_date": "" } } ], "total": 2, "count": 2 }
              
              {
    "result": [
        {
            "domain_id": 1000403,
            "name": "track.leonww.asia",
            "create_time": "2025-04-18T13:27:38+0800",
            "update_time": "2025-09-04T12:32:56+0800",
            "cname": {
                "verify": true,
                "verify_message": "Konfigurasi berhasil",
                "required_record": "track01.engagelab.email",
                "existed_record": "track01.engagelab.email"
            },
            "cert": {
                "verify": true,
                "verify_message": "sertifikat sudah aktif",
                "expired_date": "2025-12-02T07:59:59+0800"
            }
        },
        {
            "domain_id": 1000402,
            "name": "track.myMail.com",
            "create_time": "2025-04-18T13:05:57+0800",
            "update_time": "2025-04-18T13:05:57+0800",
            "cname": {
                "verify": false,
                "verify_message": "Record cname belum dikonfigurasi",
                "required_record": "track01.engagelab.email",
                "existed_record": ""
            },
            "cert": {
                "verify": false,
                "verify_message": "sertifikat belum diunggah",
                "expired_date": ""
            }
        }
    ],
    "total": 2,
    "count": 2
}
Tampilkan blok kode ini di jendela mengambang

Response-error

HTTP Status :401

{ "code": 30000, "message": "Tidak terotorisasi." }
              
              { 
    "code": 30000,
    "message": "Tidak terotorisasi."
}
Tampilkan blok kode ini di jendela mengambang

Tambah

Tambahkan domain pelacakan ke akun Anda.

URL

https://email.api.engagelab.cc/v1/tracking-domains
              
              https://email.api.engagelab.cc/v1/tracking-domains
Tampilkan blok kode ini di jendela mengambang

Content-Type:

application/json; charset=utf-8
              
              application/json; charset=utf-8
Tampilkan blok kode ini di jendela mengambang

Metode Permintaan HTTP

POST
              
              POST
Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Header Tipe Wajib Deskripsi
Authorization String ya Basic base64(apiUser:apiKey)

Deskripsi Parameter Body

Parameter Tipe Wajib Deskripsi
name string ya nama domain

Tips:

  1. Maksimal 5 domain pelacakan kustom. Nama domain tidak dapat diubah setelah terverifikasi. Konfigurasi salah dapat menyebabkan link tidak bisa diklik dan data pelacakan tidak akurat.
  2. Untuk keamanan dan pelacakan akurat, sangat disarankan mengunggah sertifikat SSL dan mengaktifkan pelacakan HTTPS.

Contoh Permintaan

curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{"name":"track.leonww.asia"}'
              
              curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{"name":"track.leonww.asia"}'
Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balikan

Parameter Deskripsi
domain_id ID domain
name nama domain
cname detail record CNAME domain
verify status konfigurasi
verify_message pesan status CNAME
required_record record CNAME yang harus dikonfigurasi
existed_record record CNAME yang sudah ada
create_time waktu pembuatan domain
update_time waktu modifikasi domain

Contoh Nilai Balikan

Response-sukses

HTTP Status: 200

{ "result": { "domain_id": 1000423, "name": "track.leonww.asia", "create_time": "2025-09-03T13:42:41+0800", "update_time": "2025-09-03T13:42:41+0800", "cname": { "verify": false, "verify_message": "Record cname belum dikonfigurasi", "required_record": "track01.engagelab.email", "existed_record": "" } } }
              
              {
    "result": {
        "domain_id": 1000423,
        "name": "track.leonww.asia",
        "create_time": "2025-09-03T13:42:41+0800",
        "update_time": "2025-09-03T13:42:41+0800",
        "cname": {
            "verify": false,
            "verify_message": "Record cname belum dikonfigurasi",
            "required_record": "track01.engagelab.email",
            "existed_record": ""
        }
    }
}
Tampilkan blok kode ini di jendela mengambang

Response-error

HTTP Status :400

{ "code": 31003, "message": "Format nama domain salah" }
              
              {
    "code": 31003,
    "message": "Format nama domain salah"
}
Tampilkan blok kode ini di jendela mengambang

Ubah

Ubah domain pelacakan melalui antarmuka ini

URL

https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}
              
              https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}
Tampilkan blok kode ini di jendela mengambang

Content-Type:

application/json; charset=utf-8
              
              application/json; charset=utf-8
Tampilkan blok kode ini di jendela mengambang

Metode Permintaan HTTP

PUT
              
              PUT
Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Header Tipe Wajib Deskripsi
Authorization String ya Basic base64(apiUser:apiKey)

Deskripsi Parameter Body

Parameter Tipe Wajib Deskripsi
name string ya nama domain, hanya huruf, angka, tanda hubung (-), titik (.), 4-255 karakter

Contoh Permintaan

curl -X PUT "https://email.api.engagelab.cc/v1/tracking-domains/22332" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{"name":"aizl.net"}'
              
              curl -X PUT "https://email.api.engagelab.cc/v1/tracking-domains/22332" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{"name":"aizl.net"}'
Tampilkan blok kode ini di jendela mengambang

Contoh Nilai Balikan

Response-sukses

HTTP Status: 200

{ "count": 1 }
              
              {
    "count": 1
}
Tampilkan blok kode ini di jendela mengambang

Response-error

HTTP Status :400

{ "code": 31003, "message": "Format nama domain salah" }
              
              {
    "code": 31003,
    "message": "Format nama domain salah"
}
Tampilkan blok kode ini di jendela mengambang

Verifikasi

Verifikasi domain pelacakan melalui antarmuka ini

URL

https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/verify
              
              https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/verify
Tampilkan blok kode ini di jendela mengambang

Metode Permintaan HTTP

GET
              
              GET
Tampilkan blok kode ini di jendela mengambang

Catatan

Mengembalikan domain dengan konfigurasi yang sudah diverifikasi.
              
              Mengembalikan domain dengan konfigurasi yang sudah diverifikasi.
Tampilkan blok kode ini di jendela mengambang

Contoh Permintaan

curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains/123/verify" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains/123/verify" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balikan

Parameter Deskripsi
domain_id ID domain
name nama domain
cname detail record CNAME domain
verify status konfigurasi (true/false)
verify_message pesan status CNAME, null jika sudah benar
required_record record CNAME yang harus dikonfigurasi
existed_record record CNAME yang sudah ada
cert detail sertifikat domain
expired_date tanggal kedaluwarsa sertifikat
create_time waktu pembuatan domain
update_time waktu modifikasi domain

Contoh Nilai Balikan

Response-sukses

HTTP Status: 200

{ "result": { "domain_id": 1000403, "name": "track.leonww.asia", "create_time": "2025-04-18T13:27:38+0800", "update_time": "2025-09-04T12:32:56+0800", "cname": { "verify": true, "verify_message": "Konfigurasi berhasil", "required_record": "track01.engagelab.email", "existed_record": "track01.engagelab.email" }, "cert": { "verify": true, "verify_message": "sertifikat sudah aktif", "expired_date": "2025-12-02T07:59:59+0800" } } }
              
              {
    "result": {
        "domain_id": 1000403,
        "name": "track.leonww.asia",
        "create_time": "2025-04-18T13:27:38+0800",
        "update_time": "2025-09-04T12:32:56+0800",
        "cname": {
            "verify": true,
            "verify_message": "Konfigurasi berhasil",
            "required_record": "track01.engagelab.email",
            "existed_record": "track01.engagelab.email"
        },
        "cert": {
            "verify": true,
            "verify_message": "sertifikat sudah aktif",
            "expired_date": "2025-12-02T07:59:59+0800"
        }
    }
}
Tampilkan blok kode ini di jendela mengambang

Response-error

HTTP Status :401

{ "code": 30000, "message": "Tidak terotorisasi." }
              
              {
    "code": 30000,
    "message": "Tidak terotorisasi."
}
Tampilkan blok kode ini di jendela mengambang

Tambah Sertifikat

Tambah sertifikat domain pelacakan

URL

https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
              
              https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
Tampilkan blok kode ini di jendela mengambang

Content-Type:

application/json; charset=utf-8
              
              application/json; charset=utf-8
Tampilkan blok kode ini di jendela mengambang

Metode Permintaan HTTP

POST
              
              POST
Tampilkan blok kode ini di jendela mengambang

Deskripsi Parameter Body

Parameter Tipe Wajib Deskripsi
cert_content string ya Isi sertifikat, format PEM
cert_key string ya Private Key sertifikat, format PEM

Contoh Permintaan

curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains/123/cert" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --data '{"cert_content":"...","cert_key":"..."}'
              
              curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains/123/cert" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --data '{"cert_content":"...","cert_key":"..."}'
Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balikan

Parameter Deskripsi
domain_id ID domain
name nama domain
cert detail sertifikat domain
verify status konfigurasi sertifikat (true/false)
verify_message status sertifikat (belum diunggah, sedang dikonfigurasi, aktif, kedaluwarsa)
expired_date tanggal kedaluwarsa sertifikat
create_time waktu pembuatan domain
update_time waktu modifikasi domain

Contoh Nilai Balikan

Response-sukses

HTTP Status: 200

{ "result": { "domain_id": 1000403, "name": "track.leonww.asia", "create_time": "2025-04-18T13:27:38+0800", "update_time": "2025-09-04T12:32:56+0800", "cert": { "verify": false, "verify_message": "sertifikat sedang dikonfigurasi", "expired_date": "2025-12-02T07:59:59+0800" } } }
              
              {
    "result": {
        "domain_id": 1000403,
        "name": "track.leonww.asia",
        "create_time": "2025-04-18T13:27:38+0800",
        "update_time": "2025-09-04T12:32:56+0800",
        "cert": {
            "verify": false,
            "verify_message": "sertifikat sedang dikonfigurasi",
            "expired_date": "2025-12-02T07:59:59+0800"
        }
    }
}
Tampilkan blok kode ini di jendela mengambang

Response-error

HTTP Status :401

{ "code": 30000, "message": "Tidak terotorisasi." }
              
              {
    "code": 30000,
    "message": "Tidak terotorisasi."
}
Tampilkan blok kode ini di jendela mengambang

Perbarui Sertifikat

Perbarui sertifikat domain pelacakan

URL

https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
              
              https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
Tampilkan blok kode ini di jendela mengambang

Content-Type:

application/json; charset=utf-8
              
              application/json; charset=utf-8
Tampilkan blok kode ini di jendela mengambang

Metode Permintaan HTTP

PUT
              
              PUT
Tampilkan blok kode ini di jendela mengambang

Deskripsi Parameter Body

Parameter Tipe Wajib Deskripsi
cert_content string ya Isi sertifikat, format PEM
cert_key string ya Private Key sertifikat, format PEM

Contoh Permintaan

curl -X PUT "https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl -X PUT "https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Tampilkan blok kode ini di jendela mengambang

Response-sukses

HTTP Status: 200

{ "count": 1 }
              
              {
    "count": 1
}
Tampilkan blok kode ini di jendela mengambang

Response-error

HTTP Status :401

{ "code": 30000, "message": "Tidak terotorisasi." }
              
              {
    "code": 30000,
    "message": "Tidak terotorisasi."
}
Tampilkan blok kode ini di jendela mengambang

Perbarui API_USER

Perbarui domain pelacakan dan konfigurasi pelacakan yang terkait dengan API_USER

URL

https://email.api.engagelab.cc/v1/api_users/{api_user}
              
              https://email.api.engagelab.cc/v1/api_users/{api_user}
Tampilkan blok kode ini di jendela mengambang

Content-Type:

application/json; charset=utf-8
              
              application/json; charset=utf-8
Tampilkan blok kode ini di jendela mengambang

Metode Permintaan HTTP

PUT
              
              PUT
Tampilkan blok kode ini di jendela mengambang

Deskripsi Parameter Body

Parameter Tipe Wajib Deskripsi
domain_name string tidak nama domain yang terhubung dengan API_USER
track_domain_name string tidak nama domain pelacakan yang terhubung dengan API_USER
open_tracking boolean tidak aktifkan open-tracking: false (nonaktif), true (aktif). Default false.
click_tracking boolean tidak aktifkan click-tracking: false (nonaktif), true (aktif). Default false.
unsubscribe_tracking boolean tidak aktifkan unsubscribe-tracking: false (nonaktif), true (aktif). Default true.

Contoh Permintaan

curl -X PUT "https://email.api.engagelab.cc/v1/api_users/{api_user}" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl -X PUT "https://email.api.engagelab.cc/v1/api_users/{api_user}" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Tampilkan blok kode ini di jendela mengambang

Response-sukses

HTTP Status: 200

{ "count": 1 }
              
              {
    "count": 1
}
Tampilkan blok kode ini di jendela mengambang

Response-error

HTTP Status :401

{ "code": 30000, "message": "Tidak terotorisasi." }
              
              {
    "code": 30000,
    "message": "Tidak terotorisasi."
}
Tampilkan blok kode ini di jendela mengambang
icon
Hubungi Sales