Precisa de documentos com dados e chaves reais?

Basta se inscrever ou fazer login para ter suas chaves de API e dados da conta real preenchidos abaixo.

Você concorda com nossa Política de Privacidade e Termos .

Não interessado? Clique aqui para continuar lendo

Índice

Criamos uma API para acesso programático a domínios, aliases e muito mais.

Documentação da API

Acesso programático aos seus dados

API de encaminhamento de email

Índice

Bibliotecas

No momento, ainda não lançamos nenhum wrapper de API, mas planejamos fazê-lo em um futuro próximo. Envie um email para api@forwardemail.net se você quiser ser notificado quando o wrapper de API de uma linguagem de programação específica for lançado. Enquanto isso, você pode usar essas bibliotecas de solicitação HTTP recomendadas em seu aplicativo ou simplesmente usar ondulação como nos exemplos abaixo.

LínguaBiblioteca
RubiFaraday
Pitãosolicitações de
JavaOkHttp
PHPbeber
Javascriptsuperagente
Node.jssuperagente
Vainet / http
.NETRestSharp

URI base

O caminho de URI base HTTP atual é: https://api.forwardemail.net. O caminho de URI base HTTP legado de https://forwardemail.net:4000 está obsoleto a partir de 1º de janeiro de 2021.

Autenticação

Todos os endpoints exigem sua Chave API para ser definido como o valor "username" da solicitação Autorização básica cabeçalho. Não se preocupe - os exemplos são fornecidos abaixo para você, se você não tiver certeza do que é isso.

Erros

Se ocorrer algum erro, o corpo da resposta da solicitação da API conterá uma mensagem de erro detalhada.

CódigoNome
200OK
400Pedido ruim
401Não autorizado
403Proibido
404Não encontrado
429Muitas solicitações
500Erro do Servidor Interno
501Não implementado
502Gateway incorreto
503Serviço indisponível
504Tempo limite do gateway
Dica: Se você receber um código de status 5xx (o que não deve acontecer), entre em contato conosco em api@forwardemail.net e nós o ajudaremos a resolver seu problema imediatamente.

Localização

Nosso serviço é traduzido para mais de 25 idiomas diferentes. Todas as mensagens de resposta da API são traduzidas para a última localidade detectada do usuário que está fazendo a solicitação da API. Você pode substituir isso passando um personalizado Accept-Language cabeçalho. Sinta-se à vontade para experimentá-lo usando o menu suspenso de idiomas na parte inferior desta página.

Paginação

Se você deseja ser notificado quando a paginação estiver disponível, envie um e-mail api@forwardemail.net.

Conta

Criar Conta

POST /v1/account

Parâmetro do corpoRequeridosTipoDescrição
emailsimString (Email)Endereço de e-mail
passwordsimCordaSenha

Solicitação de exemplo:

curl -X POST https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Recupere a conta

GET /v1/account

Solicitação de exemplo:

curl -X GET https://api.forwardemail.net/v1/account \
  -u API_TOKEN:

Atualizar conta

PUT /v1/account

Parâmetro do corpoRequeridosTipoDescrição
emailNãoString (Email)Endereço de e-mail
given_nameNãoCordaPrimeiro nome
family_nameNãoCordaÚltimo nome
avatar_urlNãoString (URL)Link para a imagem do avatar

Solicitação de exemplo:

curl -X PUT https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Domínios

Dica: Endpoints de domínio com o nome de um domínio /v1/domains/:domain_name pois seus caminhos são intercambiáveis com o ID de um domínio :domain_id. Isso significa que você pode fazer referência ao domínio por seu name ou id valor.

Listar domínios

GET /v1/domains

Parâmetro de consultaRequeridosTipoDescrição
nameNãoString (suportado por RegExp)Pesquise domínios por nome
aliasNãoString (suportado por RegExp)Pesquise domínios por nome alternativo
recipientNãoString (suportado por RegExp)Pesquise domínios por destinatário

Solicitação de exemplo:

curl -X GET https://api.forwardemail.net/v1/domains \
  -u API_TOKEN:

Criar domínio

POST /v1/domains

Parâmetro do corpoRequeridosTipoDescrição
domainsimString (FQDN ou IP)Nome de domínio totalmente qualificado ("FQDN") ou endereço IP
planNãoString (enumerável)Tipo de plano (deve ser "free", "enhanced_protection", ou "team", padrão para "free" ou o plano pago atual do usuário, se estiver em um)
catchallNãoString (endereços de e-mail delimitados) ou BooleanoCrie um alias pega-tudo padrão, o padrão é true (E se true ele usará o endereço de e-mail do usuário da API como destinatário e, se false nenhum catch-all será criado). Se uma String for passada, então é uma lista delimitada de endereços de e-mail para usar como destinatários (separados por quebra de linha, espaço e/ou vírgula)
has_adult_content_protectionNãoboleanoSe deve ativar a proteção de conteúdo adulto do Spam Scanner neste domínio
has_phishing_protectionNãoboleanoSe a proteção contra phishing do Spam Scanner deve ser habilitada neste domínio
has_executable_protectionNãoboleanoSe deve habilitar a proteção executável do Spam Scanner neste domínio
has_virus_protectionNãoboleanoSe deve habilitar a proteção contra vírus do Spam Scanner neste domínio
has_recipient_verificationNãoboleanoPadrão de domínio global para exigir que os destinatários de alias cliquem em um link de verificação de e-mail para que os e-mails fluam

Solicitação de exemplo:

curl -X POST https://api.forwardemail.net/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

Recuperar domínio

GET /v1/domains/example.com

Solicitação de exemplo:

curl -X GET https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Verificar registros de domínio

GET /v1/domains/example.com/verify-records

Solicitação de exemplo:

curl -X GET https://api.forwardemail.net/v1/domains/example.com/verify-records \
  -u API_TOKEN:

Atualizar domínio

PUT /v1/domains/example.com

Parâmetro do corpoRequeridosTipoDescrição
smtp_portNãoString ou NumberPorta personalizada para configurar para encaminhamento SMTP (o padrão é "25")
has_adult_content_protectionNãoboleanoSe deve ativar a proteção de conteúdo adulto do Spam Scanner neste domínio
has_phishing_protectionNãoboleanoSe a proteção contra phishing do Spam Scanner deve ser habilitada neste domínio
has_executable_protectionNãoboleanoSe deve habilitar a proteção executável do Spam Scanner neste domínio
has_virus_protectionNãoboleanoSe deve habilitar a proteção contra vírus do Spam Scanner neste domínio
has_recipient_verificationNãoboleanoPadrão de domínio global para exigir que os destinatários de alias cliquem em um link de verificação de e-mail para que os e-mails fluam

Solicitação de exemplo:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Excluir domínio

DELETE /v1/domains/:domain_name

Solicitação de exemplo:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
  -u API_TOKEN:

Convida

Aceitar convite de domínio

GET /v1/domains/:domain_name/invites

Solicitação de exemplo:

curl -X GET https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Criar convite de domínio

POST /v1/domains/example.com/invites

Parâmetro do corpoRequeridosTipoDescrição
emailsimString (Email)Endereço de email para convidar para a lista de membros do domínio
groupsimString (enumerável)Grupo para adicionar o usuário à associação de domínio (pode ser um dos "admin" ou "user")

Solicitação de exemplo:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/invites \
  -u API_TOKEN: \
  -d "email=user%40gmail.com" \
  -d group=admin

Remover convite de domínio

DELETE /v1/domains/:domain_name/invites

Parâmetro do corpoRequeridosTipoDescrição
emailsimString (Email)Endereço de email para remover da lista de membros do domínio

Solicitação de exemplo:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Membros

Atualizar membro do domínio

PUT /v1/domains/example.com/members/:member_id

Parâmetro do corpoRequeridosTipoDescrição
groupsimString (enumerável)Grupo para atualizar o usuário para a associação de domínio (pode ser um dos "admin" ou "user")

Solicitação de exemplo:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

Remover membro do domínio

DELETE /v1/domains/:domain_name/members/:member_id

Solicitação de exemplo:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/members/:member_id \
  -u API_TOKEN:

Apelido

Listar aliases de domínio

GET /v1/domains/example.com/aliases

Parâmetro de consultaRequeridosTipoDescrição
nameNãoString (suportado por RegExp)Pesquise aliases em um domínio por nome
recipientNãoString (suportado por RegExp)Pesquisar aliases em um domínio por destinatário

Solicitação de exemplo:

curl -X GET https://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

Crie um novo alias de domínio

POST /v1/domains/example.com/aliases

Parâmetro do corpoRequeridosTipoDescrição
namesimCordaNome alternativo
recipientssimSequência ou matrizLista de destinatários (deve ser String ou matriz separada por vírgula / espaço / vírgula de endereços de email válidos, nomes de domínio totalmente qualificados ("FQDN"), endereços IP e / ou URLs de webhook)
descriptionNãoCordaDescrição do alias
labelsNãoSequência ou matrizLista de etiquetas (deve ser String ou Matriz separadas por quebra de linha / espaço / vírgula)
has_recipient_verificationNãoboleanoSe deve ser ativado para exigir que os destinatários cliquem em um link de verificação de e-mail para que os e-mails fluam (o padrão é a configuração do domínio, se não for definido explicitamente no corpo da solicitação)
is_enabledNãoboleanoSe você deseja desativar esse alias (se desativado, os e-mails não serão roteados para lugar nenhum, mas retornarão códigos de status bem-sucedidos)

Solicitação de exemplo:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

Recuperar alias de domínio

Você pode recuperar um alias de domínio por seu id ou seu name valor.

GET /v1/domains/:domain_name/aliases/:alias_id

Solicitação de exemplo:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

GET /v1/domains/:domain_name/aliases/:alias_name

Solicitação de exemplo:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_name \
  -u API_TOKEN:

Atualizar alias do domínio

PUT /v1/domains/example.com/aliases/:alias_id

Parâmetro do corpoRequeridosTipoDescrição
nameNãoCordaNome alternativo
recipientssimSequência ou matrizLista de destinatários (deve ser String ou matriz separada por vírgula / espaço / vírgula de endereços de email válidos, nomes de domínio totalmente qualificados ("FQDN"), endereços IP e / ou URLs de webhook)
descriptionNãoCordaDescrição do alias
labelsNãoSequência ou matrizLista de etiquetas (deve ser String ou Matriz separadas por quebra de linha / espaço / vírgula)
has_recipient_verificationNãoboleanoSe deve ser ativado para exigir que os destinatários cliquem em um link de verificação de e-mail para que os e-mails fluam (o padrão é a configuração do domínio, se não for definido explicitamente no corpo da solicitação)
is_enabledNãoboleanoSe você deseja desativar esse alias (se desativado, os e-mails não serão roteados para lugar nenhum, mas retornarão códigos de status bem-sucedidos)

Solicitação de exemplo:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id \
  -u API_TOKEN:

Excluir alias do domínio

DELETE /v1/domains/:domain_name/aliases/:alias_id

Solicitação de exemplo:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN: