API

Shtoni një domen

Shton një domen në hapësirën e punës dhe e kthen me çdo regjistrim DNS që i duhet. Domeni fillon i paverifikuar, me catch-all të ndezur, dhe verifikohet vetë sapo regjistrimet përgjigjen në DNS publik.

POSTapi.openemail.uk/domains

Ekzekuton thirrjen reale kundrejt hapësirës suaj të punës, me çelësin tuaj.

POST /domains

Kërkesa

Parametrat

domainstringe detyrueshme: Një domen i thjeshtë si `acme.com` ose `mail.acme.com`. Pastrohet nga hapësirat dhe kthehet në shkronja të vogla, ndërsa një emër ndërkombëtar ruhet në formën e tij ASCII. Një skemë, një shteg ose një adresë refuzohen.

Shembull

Kërkon domains:write dhe një çelës pa kufizim adrese ose domeni, sepse një domen i ri shtrihet në të gjithë hapësirën e punës.

curl

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

Përgjigje

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

Shembulli e shkurton records. Një përgjigje e vërtetë liston çdo regjistrim që i duhet domenit, përfshirë DMARC, CNAME-t e nënshkrimit dhe regjistrimet e return-path, dhe GET /domains/{id} përshkruan çdo fushë.

Publikoni regjistrimet saktësisht siç jepen, pastaj thirrni POST /domains/{id}/verify ose prisni: domeni kontrollohet përsëri sa herë lexohet dhe nga një kontroll i përgjithshëm në sfond, dhe domain.verified aktivizohet në çastin që kalon.

Kur refuzohet

409 domain_already_added: ky pronar i hapësirës së punës e ka tashmë domenin.
409 domain_claimed: e ka një llogari tjetër.
409 related_domain_owned: një domen prind ose një nëndomen i tij i përket një llogarie tjetër, kështu që nuk mund të ndahet mes të dyve.
409 operator_domain: domeni i përket vetë OpenEmail.
403 domain_allowance_reached: plani nuk mban më domene. Mesazhi përmend planin që mban më shumë.
422 capability_unsupported: çelësi është i kufizuar në adresa ose domene të caktuara.