Saltar para a documentação
API

Obter o endereço da app web

O endereço da app web do espaço de trabalho, se é possível iniciar sessão ali, e o registo CNAME de que precisa. Sem nenhum definido, `status` é `none` e `domains` lista os domínios sob os quais se pode definir um.

GET/app-host

Executa a chamada real no seu espaço de trabalho.

GET /app-host

O endereço da app web do espaço de trabalho, se é possível iniciar sessão ali, e o registo CNAME de que precisa. Sem nenhum definido, status é none e domains lista os domínios sob os quais se pode definir um.

O que é o endereço da app web

shell
export OE=https://api.openemail.ukexport AUTH="Authorization: Bearer $OPENEMAIL_API_KEY"

Um espaço de trabalho num plano pago pode abrir a app web num subdomínio de um dos seus domínios verificados, como mailbox.acme.com, e também em openemail.uk. É o endereço definido no separador App com a sua marca das definições de Aspeto do espaço de trabalho, e um espaço de trabalho tem no máximo um.

Só os membros do espaço de trabalho, as pessoas que iniciam sessão com um dos seus endereços e quem tiver um convite pendente podem iniciar sessão ali, e só eles recebem a partir dali os emails de reposição da palavra-passe e de verificação. Tem o aspeto de openemail.uk até o espaço de trabalho definir um logótipo na sua página de Aspeto, e depois mostra o logótipo, o símbolo e o nome do espaço de trabalho em vez dos nossos. A partir daí, os emails que a OpenEmail lhes envia levam a marca, remetem para o endereço e vêm de noreply@ do seu domínio assim que os registos de assinatura desse domínio estiverem verificados.

Precisa de um registo CNAME, que record indica em pormenor. O endereço fica pending até o registo responder e o seu certificado ser emitido, e passa a active depois disso. No plano gratuito é mantido mas fica em pausa: paused é true e ninguém pode iniciar sessão ali até o espaço de trabalho voltar a ter um plano pago.

Exemplo

Requer domains:read.

curl
curl "$OE/app-host" -H "$AUTH"
Resposta
{  "object": "app_host",  "id": "ahost_3f9c2a71d0b84e56a1c7f2e9",  "host": "mailbox.acme.com",  "domainId": "b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f",  "domain": "acme.com",  "status": "active",  "active": true,  "paused": false,  "target": "cname.openemail.uk",  "record": {    "type": "CNAME",    "name": "mailbox.acme.com",    "value": "cname.openemail.uk"  },  "error": null,  "checkedAt": "2026-10-01T09:12:30.000Z",  "verifiedAt": "2026-10-01T09:04:11.000Z",  "available": true,  "paidPlan": true,  "domains": ["acme.com"],  "suggested": "mailbox.acme.com"}

Ler o endereço volta a verificá-lo quando a última verificação tem mais de 15 segundos, por isso consultar esta rota periodicamente é a forma de esperar que active passe a true.

active só é true quando status é active e o espaço de trabalho está num plano pago. paused é true quando há um endereço definido e o espaço de trabalho está no plano gratuito.

A sua caixa de entrada,
nos seus termos.

Infraestrutura de email para empresas, IA, agentes e correio pessoal. Feita para escala, privacidade e controlo. Tudo o que o email devia ter tido desde o primeiro dia.

© 2026 OpenEmail. Todos os direitos reservados.