Beranda › Dokumentasi › Referensi API › Domain

Domain

Tambah dan kelola domain kustom dengan kesiapan pengiriman dan penerimaan terpisah. Verifikasi catatan identitas pengirim dan periksa routing MX secara independen.

Ikhtisar

Secara default, kotak masuk mengirim dari @agentsend.io. Menambahkan domain Anda sendiri memungkinkan Anda mengirim dari alamat seperti agent@domainanda.com, meningkatkan keterkiriman dan kepercayaan merek.

Setelah menambahkan domain, AgentSend mengembalikan catatan DNS terpisah untuk pengiriman dan penerimaan. Setelah dipublikasikan, panggil endpoint verify untuk menyegarkan kedua status: pengiriman memeriksa verifikasi pengirim SES dan DKIM, sementara penerimaan memeriksa apakah MX domain menunjuk ke AgentSend.

ℹ

Semua request memerlukan header x-api-key. Dapatkan kunci Anda dari dasbor.

Objek Domain

Semua endpoint domain mengembalikan objek Domain (atau array darinya).

Domain object 
{
  "id":                 "dom_01hxyz...",          // UUID
  "domain":             "mail.yourdomain.com",
  "sendingStatus":      "pending",              // pending | pending_dkim | verified | failed
  "receivingStatus":    "pending",              // pending | verified | failed
  "verificationStatus": "pending",              // backward-compatible alias of sendingStatus
  "sendingDnsRecords": [
    {
      "type":  "TXT",
      "name":  "_amazonses.mail.yourdomain.com",
      "value": "verification-token"
    },
    {
      "type":  "CNAME",
      "name":  "agsend1._domainkey.mail.yourdomain.com",
      "value": "agsend1.dkim.amazonses.com"
    }
  ],
  "receivingDnsRecords": [
    {
      "type":  "MX",
      "name":  "mail.yourdomain.com",
      "value": "mx.agentsend.io",
      "priority": 10
    }
  ],
  "dnsRecords": [
    {
      "type":  "TXT",
      "name":  "_amazonses.mail.yourdomain.com",
      "value": "verification-token"
    }
  ],
  "sendingVerifiedAt": null,
  "receivingVerifiedAt": null,
  "createdAt": "2024-11-01T09:00:00Z"
}
Field Tipe Deskripsi
idstringPengenal domain unik (UUID).
domainstringDomain atau subdomain yang Anda tambahkan.
sendingStatusstringStatus verifikasi pengirim. pending, pending_dkim, verified, atau failed.
receivingStatusstringStatus routing masuk berdasarkan MX. pending, verified, atau failed.
verificationStatusstringAlias kompatibel mundur dari sendingStatus.
sendingDnsRecordsarrayCatatan DNS yang diperlukan untuk verifikasi pengiriman dan penandatanganan DKIM.
receivingDnsRecordsarrayCatatan DNS yang diperlukan jika Anda ingin AgentSend menerima email masuk untuk domain.
dnsRecordsarrayDaftar gabungan catatan pengiriman dan penerimaan untuk kemudahan.
sendingVerifiedAtstring | nullSaat verifikasi pengiriman terakhir mencapai verified.
receivingVerifiedAtstring | nullSaat verifikasi MX terakhir mencapai verified.
createdAtstring (ISO 8601)Timestamp saat domain ditambahkan.

POST /domains

Tambahkan domain kustom. Mengembalikan objek Domain baru termasuk catatan DNS yang harus Anda publikasikan sebelum verifikasi.

Body request

ParameterTipeDeskripsi
domain wajib string Domain atau subdomain untuk ditambahkan, misalnya mail.domainanda.com.
curl 
curl -X POST https://api.agentsend.io/domains \
  -H "x-api-key: $AGENTSEND_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain": "mail.yourdomain.com"}'

Respons 201 Created

json 
{
  "id": "dom_01hxyz4k9s2n3p7q",
  "domain": "mail.yourdomain.com",
  "verificationStatus": "pending",
  "dnsRecords": [
    {
      "type": "TXT",
      "name": "mail.yourdomain.com",
      "value": "v=spf1 include:spf.agentsend.io ~all"
    },
    {
      "type": "CNAME",
      "name": "agsend1._domainkey.mail.yourdomain.com",
      "value": "agsend1._domainkey.agentsend.io"
    },
    {
      "type": "CNAME",
      "name": "agsend2._domainkey.mail.yourdomain.com",
      "value": "agsend2._domainkey.agentsend.io"
    }
  ],
  "createdAt": "2024-11-01T09:00:00Z"
}
💡

Publikasikan semua dnsRecords yang dikembalikan di registrar DNS Anda, lalu panggil POST /domains/{id}/verify untuk mengaktifkan domain.

GET /domains

Daftar semua domain di akun Anda, termasuk status verifikasi saat ini.

Parameter

Tidak ada parameter query.

curl 
curl https://api.agentsend.io/domains \
  -H "x-api-key: $AGENTSEND_API_KEY"

Respons 200 OK

json 
{
  "data": [
    {
      "id": "dom_01hxyz4k9s2n3p7q",
      "domain": "mail.yourdomain.com",
      "verificationStatus": "verified",
      "dnsRecords": [ /* ... */ ],
      "createdAt": "2024-11-01T09:00:00Z"
    },
    {
      "id": "dom_01hzab8m3t4r2w9c",
      "domain": "outbound.acme.io",
      "verificationStatus": "pending",
      "dnsRecords": [ /* ... */ ],
      "createdAt": "2024-11-15T14:23:00Z"
    }
  ]
}

GET /domains/{id}

Ambil satu domain berdasarkan ID, termasuk catatan DNS lengkap dan status verifikasi saat ini.

Parameter path

ParameterTipeDeskripsi
id wajib string (uuid) ID domain untuk diambil.
curl 
curl https://api.agentsend.io/domains/dom_01hxyz4k9s2n3p7q \
  -H "x-api-key: $AGENTSEND_API_KEY"

Respons 200 OK

json 
{
  "id": "dom_01hxyz4k9s2n3p7q",
  "domain": "mail.yourdomain.com",
  "verificationStatus": "verified",
  "dnsRecords": [
    {
      "type": "TXT",
      "name": "mail.yourdomain.com",
      "value": "v=spf1 include:spf.agentsend.io ~all"
    },
    {
      "type": "CNAME",
      "name": "agsend1._domainkey.mail.yourdomain.com",
      "value": "agsend1._domainkey.agentsend.io"
    },
    {
      "type": "CNAME",
      "name": "agsend2._domainkey.mail.yourdomain.com",
      "value": "agsend2._domainkey.agentsend.io"
    }
  ],
  "createdAt": "2024-11-01T09:00:00Z"
}

DELETE /domains/{id}

Menghapus domain dari akun Anda secara permanen. Kotak masuk yang menggunakan domain ini akan kembali ke alamat @agentsend.io. Tindakan ini tidak dapat dibatalkan.

Parameter path

ParameterTipeDeskripsi
id wajib string (uuid) ID domain yang akan dihapus.
curl 
curl -X DELETE https://api.agentsend.io/domains/dom_01hxyz4k9s2n3p7q \
  -H "x-api-key: $AGENTSEND_API_KEY"

Respons 204 No Content

Mengembalikan body kosong saat sukses.

⚠

Menghapus domain tidak menghapus catatan DNS dari registrar Anda. Anda harus membersihkannya secara manual setelah penghapusan.

POST /domains/{id}/verify

Picu pemeriksaan kesiapan domain baru. AgentSend memperbarui verifikasi pengirim dari SES dan DKIM, lalu secara terpisah memeriksa apakah MX domain menunjuk ke AgentSend untuk email masuk.

Parameter path

ParameterTipeDeskripsi
id wajib string (uuid) ID domain yang akan diverifikasi.
curl 
curl -X POST https://api.agentsend.io/domains/dom_01hxyz4k9s2n3p7q/verify \
  -H "x-api-key: $AGENTSEND_API_KEY"

Respons 200 OK

Mengembalikan objek Domain yang diperbarui. Periksa sendingStatus dan receivingStatus untuk melihat hasil terbaru.

json — verified 
{
  "id": "dom_01hxyz4k9s2n3p7q",
  "domain": "mail.yourdomain.com",
  "verificationStatus": "verified",
  "dnsRecords": [
    {
      "type": "TXT",
      "name": "mail.yourdomain.com",
      "value": "v=spf1 include:spf.agentsend.io ~all"
    },
    {
      "type": "CNAME",
      "name": "agsend1._domainkey.mail.yourdomain.com",
      "value": "agsend1._domainkey.agentsend.io"
    },
    {
      "type": "CNAME",
      "name": "agsend2._domainkey.mail.yourdomain.com",
      "value": "agsend2._domainkey.agentsend.io"
    }
  ],
  "createdAt": "2024-11-01T09:00:00Z"
}
json — pending_dkim (ownership ok, DKIM not yet propagated) 
{
  "id": "dom_01hxyz4k9s2n3p7q",
  "domain": "mail.yourdomain.com",
  "verificationStatus": "pending_dkim",
  "dnsRecords": [ /* ... */ ],
  "createdAt": "2024-11-01T09:00:00Z"
}
ℹ

Perubahan DNS dapat memakan waktu hingga 48 jam untuk menyebar ke seluruh dunia. Jika verifikasi mengembalikan pending_dkim atau failed, tunggu beberapa menit dan panggil verify lagi.

← Sebelumnya API: Webhooks