Τομείς

Προσθέστε και διαχειριστείτε προσαρμοσμένους τομείς με ξεχωριστή ετοιμότητα αποστολής και λήψης. Επαληθεύστε εγγραφές ταυτότητας αποστολέα και ελέγξτε MX routing ανεξάρτητα.

Επισκόπηση

Από προεπιλογή, τα inboxes στέλνουν από @agentsend.io. Προσθέτοντας τον δικό σας τομέα μπορείτε να στέλνετε από διευθύνσεις όπως agent@yourdomain.com, βελτιώνοντας την παραδοσιμότητα και την εμπιστοσύνη της μάρκας.

Μετά την προσθήκη τομέα, το AgentSend επιστρέφει ξεχωριστές εγγραφές DNS για αποστολή και λήψη. Μόλις δημοσιευθούν, καλέστε το endpoint επαλήθευσης για να ανανεώσετε και τις δύο καταστάσεις: η αποστολή ελέγχει την επαλήθευση αποστολέα SES και DKIM, ενώ η λήψη ελέγχει αν το MX του τομέα δείχνει στο AgentSend.

Όλα τα requests απαιτούν κεφαλίδα x-api-key. Αποκτήστε το κλειδί σας από τον πίνακα ελέγχου.

Το Αντικείμενο Τομέα

Όλα τα endpoints τομέα επιστρέφουν αντικείμενο Domain (ή πίνακα αυτών).

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"
}
Πεδίο Τύπος Περιγραφή
idstringΜοναδικό αναγνωριστικό τομέα (UUID).
domainstringΟ τομέας ή υποτομέας που προσθέσατε.
sendingStatusstringΚατάσταση επαλήθευσης αποστολέα. pending, pending_dkim, verified ή failed.
receivingStatusstringΚατάσταση εισερχόμενης δρομολόγησης με βάση το MX. pending, verified ή failed.
verificationStatusstringBackward-compatible alias του sendingStatus.
sendingDnsRecordsarrayΕγγραφές DNS που απαιτούνται για επαλήθευση αποστολής και υπογραφή DKIM.
receivingDnsRecordsarrayΕγγραφές DNS που απαιτούνται αν θέλετε το AgentSend να λαμβάνει εισερχόμενο mail για τον τομέα.
dnsRecordsarrayΣυνδυασμένη λίστα εγγραφών αποστολής και λήψης για ευκολία.
sendingVerifiedAtstring | nullΠότε η επαλήθευση αποστολής έφτασε τελευταία σε verified.
receivingVerifiedAtstring | nullΠότε η επαλήθευση MX έφτασε τελευταία σε verified.
createdAtstring (ISO 8601)Χρονοσήμανση προσθήκης του τομέα.

POST /domains

Προσθέστε προσαρμοσμένο τομέα. Επιστρέφει το νέο αντικείμενο Domain συμπεριλαμβανομένων των εγγραφών DNS που πρέπει να δημοσιεύσετε πριν την επαλήθευση.

Σώμα request

ΠαράμετροςΤύποςΠεριγραφή
domain απαιτείται string Ο τομέας ή υποτομέας προς προσθήκη, π.χ. mail.yourdomain.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"}'

Απάντηση 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"
}
💡

Δημοσιεύστε όλα τα επιστρεφόμενα dnsRecords στον registrar DNS σας, μετά καλέστε POST /domains/{id}/verify για να ενεργοποιήσετε τον τομέα.


GET /domains

Δείτε λίστα όλων των τομέων στον λογαριασμό σας, συμπεριλαμβανομένης της τρέχουσας κατάστασης επαλήθευσης.

Παράμετροι

Χωρίς παραμέτρους query.

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

Απάντηση 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}

Ανακτήστε μεμονωμένο τομέα με ID, συμπεριλαμβανομένων των πλήρων εγγραφών DNS και της τρέχουσας κατάστασης επαλήθευσης.

Παράμετροι διαδρομής

ΠαράμετροςΤύποςΠεριγραφή
id απαιτείται string (uuid) Το ID του τομέα προς ανάκτηση.
curl
curl https://api.agentsend.io/domains/dom_01hxyz4k9s2n3p7q \
  -H "x-api-key: $AGENTSEND_API_KEY"

Απάντηση 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}

Διαγράφει μόνιμα τομέα από τον λογαριασμό σας. Τα inboxes που χρησιμοποιούν αυτόν τον τομέα θα επανέλθουν σε διευθύνσεις @agentsend.io. Αυτή η ενέργεια είναι μη αναστρέψιμη.

Παράμετροι διαδρομής

ΠαράμετροςΤύποςΠεριγραφή
id απαιτείται string (uuid) Το ID του τομέα προς διαγραφή.
curl
curl -X DELETE https://api.agentsend.io/domains/dom_01hxyz4k9s2n3p7q \
  -H "x-api-key: $AGENTSEND_API_KEY"

Απάντηση 204 No Content

Επιστρέφει κενό σώμα σε επιτυχία.

Η διαγραφή τομέα δεν αφαιρεί τις εγγραφές DNS από τον registrar σας. Πρέπει να τις καθαρίσετε χειροκίνητα μετά τη διαγραφή.


POST /domains/{id}/verify

Ενεργοποιήστε νέο έλεγχο ετοιμότητας τομέα. Το AgentSend ενημερώνει την επαλήθευση αποστολέα από SES και DKIM, και μετά ελέγχει ξεχωριστά αν το MX του τομέα δείχνει στο AgentSend για εισερχόμενο mail.

Παράμετροι διαδρομής

ΠαράμετροςΤύποςΠεριγραφή
id απαιτείται string (uuid) Το ID του τομέα προς επαλήθευση.
curl
curl -X POST https://api.agentsend.io/domains/dom_01hxyz4k9s2n3p7q/verify \
  -H "x-api-key: $AGENTSEND_API_KEY"

Απάντηση 200 OK

Επιστρέφει το ενημερωμένο αντικείμενο Domain. Ελέγξτε sendingStatus και receivingStatus για να δείτε το τελευταίο αποτέλεσμα.

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"
}

Οι αλλαγές DNS μπορούν να χρειαστούν έως 48 ώρες για να διαδοθούν παγκοσμίως. Αν η επαλήθευση επιστρέψει pending_dkim ή failed, περιμένετε λίγα λεπτά και καλέστε verify ξανά.