API

Alan adı ekleme

Çalışma alanına bir alan adı ekler ve onu ihtiyaç duyduğu her DNS kaydıyla birlikte döndürür. Alan adı doğrulanmamış ve catch-all açık olarak başlar; kayıtlar herkese açık DNS'te yanıt verdiğinde kendiliğinden doğrulanır.

POSTapi.openemail.uk/domains

Gerçek çağrıyı kendi anahtarınızla çalışma alanınıza karşı çalıştırır.

POST /domains

İstek

Parametreler

domainstringzorunlu: `acme.com` veya `mail.acme.com` gibi yalın bir alan adı. Boşlukları kırpılır ve küçük harfe çevrilir; uluslararası bir ad ASCII biçiminde saklanır. Şema, yol ya da adres reddedilir.

Örnek

domains:write ve adres ya da alan adı kısıtlaması olmayan bir anahtar gerektirir, çünkü yeni bir alan adı tüm çalışma alanına erişir.

curl

curl -X POST "$OE/domains" -H "$AUTH" -H "Content-Type: application/json" \  -d '{ "domain": "acme.com" }'

Yanıt

{  "object": "domain",  "id": "b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f",  "domain": "acme.com",  "receiving": {    "verified": false,    "verifiedAt": null,    "catchAll": true,    "lastCheckedAt": "2026-09-25T10:00:02.000Z",    "error": "No MX records yet. DNS changes can take a few minutes to spread."  },  "sending": {    "status": "no_identity",    "canSend": false,    "checkedAt": null,    "error": null,    "note": "Sending is not set up yet. Publish the signing record listed for this domain, and sending switches on shortly after it answers in DNS."  },  "tracking": { "host": null, "status": "none", "active": false, "target": "", "record": null, "checkedAt": null, "verifiedAt": null, "error": null },  "storage": { "host": null, "status": "none", "active": false, "target": "", "record": null, "checkedAt": null, "verifiedAt": null, "error": null },  "addresses": [],  "createdAt": "2026-09-25T10:00:00.000Z",  "records": [    { "type": "MX", "name": "acme.com", "value": "inbound.mail.example", "priority": 10, "purpose": null, "status": "missing" },    { "type": "TXT", "name": "acme.com", "value": "v=spf1 include:_spf.openemail.uk ~all", "priority": null, "purpose": null, "status": "missing" },    { "type": "TXT", "name": "_openemail-challenge.acme.com", "value": "oe-verify=4f1c9a2b7e8d6053a1c4", "priority": null, "purpose": "Proves you own this domain", "status": "missing" }  ],  "dmarc": null}

Örnek records listesini kısaltır. Gerçek bir yanıt, alan adının ihtiyaç duyduğu her kaydı listeler; DMARC, imzalama CNAME'leri ve return-path kayıtları dahil. Her alanı GET /domains/{id} açıklar.

Kayıtları tam olarak verildiği gibi yayımlayın, ardından POST /domains/{id}/verify çağırın ya da bekleyin: alan adı her okunduğunda ve bir arka plan taramasıyla yeniden denetlenir ve denetimi geçtiği anda domain.verified tetiklenir.

Ne zaman reddedilir

409 domain_already_added: bu çalışma alanının sahibinde alan adı zaten var.
409 domain_claimed: başka bir hesapta var.
409 related_domain_owned: bir üst alan adı ya da alt alan adı başka bir hesaba ait, bu yüzden ikisi arasında bölünemez.
409 operator_domain: alan adı OpenEmail'in kendisine ait.
403 domain_allowance_reached: plan daha fazla alan adı barındırmaz. İleti, daha fazlasını barındıran planın adını verir.
422 capability_unsupported: anahtar belirli adreslerle ya da alan adlarıyla sınırlı.