Domain
Pengguna wajib mengonfigurasi domain email untuk dapat mengirim email melalui EngageLab.
Anda dapat melakukan query, menambah, atau mengubah domain.
Alamat Endpoint
| 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 benar.
POST/v1/domains
Query (Batch)
Query domain melalui endpoint ini.
URL
https://email.api.engagelab.cc/v1/domains
https://email.api.engagelab.cc/v1/domains
Tampilkan blok kode ini di jendela mengambang
Metode HTTP Request
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 |
|---|---|---|---|
| names | string | tidak | nama domain, gunakan ; sebagai pemisah |
| type | int | tidak | tipe domain: 0 (uji coba), 1 (umum) |
Contoh Permintaan
curl "https://email.api.engagelab.cc/v1/domains?name=engagelab.com;xjm.cc" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/domains?name=engagelab.com;xjm.cc" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Tampilkan blok kode ini di jendela mengambang
Deskripsi Nilai Balik
| Parameter | Deskripsi |
|---|---|
| domain_id | ID domain |
| name | nama domain |
| type | tipe domain |
| verify | status verifikasi |
| spf | konfigurasi SPF |
| dkim | konfigurasi DKIM |
| mx | konfigurasi MX |
| dmarc | konfigurasi DMARC |
| create_time | waktu pembuatan domain |
| update_time | waktu modifikasi domain |
Contoh Nilai Balik
Response-sukses
HTTP Status: 200
{
"result": [
{
"domain_id": 147799,
"name": "22edc.com",
"type": 1,
"spf": {
"domain": "22edc.com",
"value": "v=spf1 include:spf.email.engagelab.com -all",
"verify": false
},
"dkim": {
"domain": "mail._domainkey.22edc.com",
"value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB",
"verify": false
},
"mx": {
"domain": "22edc.com",
"value": "mx1.engagelab.com",
"verify": false
},
"dmarc": {
"domain": "_dmarc.22edc.com",
"value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com",
"verify": false
},
"create_time": "2022-11-12T15:38:14+0800",
"update_time": "2022-12-15T10:52:05+0800"
}
],
"count": 1
}
{
"result": [
{
"domain_id": 147799,
"name": "22edc.com",
"type": 1,
"spf": {
"domain": "22edc.com",
"value": "v=spf1 include:spf.email.engagelab.com -all",
"verify": false
},
"dkim": {
"domain": "mail._domainkey.22edc.com",
"value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB",
"verify": false
},
"mx": {
"domain": "22edc.com",
"value": "mx1.engagelab.com",
"verify": false
},
"dmarc": {
"domain": "_dmarc.22edc.com",
"value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com",
"verify": false
},
"create_time": "2022-11-12T15:38:14+0800",
"update_time": "2022-12-15T10:52:05+0800"
}
],
"count": 1
}
Tampilkan blok kode ini di jendela mengambang
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Autentikasi gagal."
}
{
"code": 30000,
"message": "Autentikasi gagal."
}
Tampilkan blok kode ini di jendela mengambang
Tambah
Tambah domain melalui endpoint ini
URL
https://email.api.engagelab.cc/v1/domains
https://email.api.engagelab.cc/v1/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 HTTP Request
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, hanya [0-9a-zA-Z-.], 4~255 karakter, contoh: mail.test.best. |
Tips:
- Setiap pengguna dapat menambah hingga 5 domain.
Contoh Permintaan
curl -X POST "https://email.api.engagelab.cc/v1/domains" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{"name":"m1314520.com"}'
curl -X POST "https://email.api.engagelab.cc/v1/domains" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{"name":"m1314520.com"}'
Tampilkan blok kode ini di jendela mengambang
Deskripsi Nilai Balik
| Parameter | Deskripsi |
|---|---|
| domain_id | ID domain |
| name | nama domain |
| type | tipe domain |
| spf | konfigurasi SPF |
| dkim | konfigurasi DKIM |
| mx | konfigurasi MX |
| dmarc | konfigurasi DMARC |
| create_time | waktu pembuatan domain |
| update_time | waktu modifikasi domain |
Contoh Nilai Balik
Response-sukses
HTTP Status: 200
{
"result": {
"domain_id": 147799,
"name": "22edc.com",
"type": 1,
"spf": {
"domain": "22edc.com",
"value": "v=spf1 include:spf.email.engagelab.com -all",
"verify": false
},
"dkim": {
"domain": "mail._domainkey.22edc.com",
"value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB",
"verify": false
},
"mx": {
"domain": "22edc.com",
"value": "mx1.engagelab.com",
"verify": false
},
"dmarc": {
"domain": "_dmarc.22edc.com",
"value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com",
"verify": false
},
"create_time": "2022-11-12T15:38:14+0800",
"update_time": "2022-12-15T10:52:05+0800"
}
}
{
"result": {
"domain_id": 147799,
"name": "22edc.com",
"type": 1,
"spf": {
"domain": "22edc.com",
"value": "v=spf1 include:spf.email.engagelab.com -all",
"verify": false
},
"dkim": {
"domain": "mail._domainkey.22edc.com",
"value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB",
"verify": false
},
"mx": {
"domain": "22edc.com",
"value": "mx1.engagelab.com",
"verify": false
},
"dmarc": {
"domain": "_dmarc.22edc.com",
"value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com",
"verify": false
},
"create_time": "2022-11-12T15:38:14+0800",
"update_time": "2022-12-15T10:52:05+0800"
}
}
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 melalui endpoint ini
URL
https://email.api.engagelab.cc/v1/domains/{domain_id}
https://email.api.engagelab.cc/v1/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 HTTP Request
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 [0-9a-zA-Z-.], 4~255 karakter, contoh: mail.test.best. |
Tips:
Domain yang sudah terverifikasi tidak dapat diubah.
Contoh Permintaan
curl -X PUT "https://email.api.engagelab.cc/v1/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/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
Deskripsi Nilai Balik
| Parameter | Deskripsi |
|---|---|
| domain_id | ID domain |
| name | nama domain |
| type | tipe domain |
| spf | konfigurasi SPF |
| dkim | konfigurasi DKIM |
| mx | konfigurasi MX |
| dmarc | konfigurasi DMARC |
| create_time | waktu pembuatan domain |
| update_time | waktu modifikasi domain |
Contoh Nilai Balik
Response-sukses
HTTP Status: 200
{
"result": {
"domain_id": 147799,
"name": "22edc.com",
"type": 1,
"spf": {
"domain": "22edc.com",
"value": "v=spf1 include:spf.email.engagelab.com -all",
"verify": false
},
"dkim": {
"domain": "mail._domainkey.22edc.com",
"value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB",
"verify": false
},
"mx": {
"domain": "22edc.com",
"value": "mx1.engagelab.com",
"verify": false
},
"dmarc": {
"domain": "_dmarc.22edc.com",
"value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com",
"verify": false
},
"create_time": "2022-11-12T15:38:14+0800",
"update_time": "2022-11-22T13:39:05+0800"
}
}
{
"result": {
"domain_id": 147799,
"name": "22edc.com",
"type": 1,
"spf": {
"domain": "22edc.com",
"value": "v=spf1 include:spf.email.engagelab.com -all",
"verify": false
},
"dkim": {
"domain": "mail._domainkey.22edc.com",
"value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB",
"verify": false
},
"mx": {
"domain": "22edc.com",
"value": "mx1.engagelab.com",
"verify": false
},
"dmarc": {
"domain": "_dmarc.22edc.com",
"value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com",
"verify": false
},
"create_time": "2022-11-12T15:38:14+0800",
"update_time": "2022-11-22T13:39:05+0800"
}
}
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 melalui endpoint ini
URL
https://email.api.engagelab.cc/v1/domains/check
https://email.api.engagelab.cc/v1/domains/check
Tampilkan blok kode ini di jendela mengambang
Metode HTTP Request
GET
GET
Tampilkan blok kode ini di jendela mengambang
Deskripsi Parameter
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| name | string | tidak | nama domain, beberapa domain gunakan ';' |
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/domains/check?name=aizl.net;m1214520.com" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X POST "https://email.api.engagelab.cc/v1/domains/check?name=aizl.net;m1214520.com" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Tampilkan blok kode ini di jendela mengambang
Deskripsi Nilai Balik
| Parameter | Deskripsi |
|---|---|
| name | nama domain |
| type | tipe domain |
| config | objek konfigurasi |
| dkim | true/false |
| mx | true/false |
| spf | true/false |
| dmarc | true/false |
| status | 0: belum diverifikasi, 1: dapat digunakan, 2: terverifikasi |
Contoh Nilai Balik
Response-sukses
HTTP Status: 200
{
"result": [
{
"name": "abc.com",
"type": 1,
"config": {
"dkim": false,
"mx": false,
"spf": false,
"dmarc": false
},
"status": 2
}
]
}
{
"result": [
{
"name": "abc.com",
"type": 1,
"config": {
"dkim": false,
"mx": false,
"spf": false,
"dmarc": false
},
"status": 2
}
]
}
Tampilkan blok kode ini di jendela mengambang
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Autentikasi gagal."
}
{
"code": 30000,
"message": "Autentikasi gagal."
}
Tampilkan blok kode ini di jendela mengambang
