API de encaminhamento de email

Índice

• Bibliotecas
• URI base
• Autenticação
• Erros
• Localização
• Paginação
• Conta
  • Criar Conta
  • Recupere a conta
  • Atualizar conta
• Domínios
  • Listar domínios
  • Criar domínio
  • Recuperar domínio
  • Verificar registros de domínio
  • Atualizar domínio
  • Excluir domínio
• Convida
  • Aceitar convite de domínio
  • Criar convite de domínio
  • Remover convite de domínio
• Membros
  • Atualizar membro do domínio
  • Remover membro do domínio
• Apelido
  • Listar aliases de domínio
  • Crie um novo alias de domínio
  • Recuperar alias de domínio
  • Atualizar alias do domínio
  • Excluir alias do domínio

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íngua	Biblioteca
Rubi	Faraday
Pitão	solicitações de
Java	OkHttp
PHP	beber
Javascript	superagente
Node.js	superagente
Vai	net / http
.NET	RestSharp

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ódigo	Nome
200	OK
400	Pedido ruim
401	Não autorizado
403	Proibido
404	Não encontrado
429	Muitas solicitações
500	Erro do Servidor Interno
501	Não implementado
502	Gateway incorreto
503	Serviço indisponível
504	Tempo limite do gateway

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 corpo	Requeridos	Tipo	Descrição
email	sim	String (Email)	Endereço de e-mail
password	sim	Corda	Senha

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 corpo	Requeridos	Tipo	Descrição
email	Não	String (Email)	Endereço de e-mail
given_name	Não	Corda	Primeiro nome
family_name	Não	Corda	Último nome
avatar_url	Não	String (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

Listar domínios

GET /v1/domains

Parâmetro de consulta	Requeridos	Tipo	Descrição
name	Não	String (suportado por RegExp)	Pesquise domínios por nome
alias	Não	String (suportado por RegExp)	Pesquise domínios por nome alternativo
recipient	Não	String (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 corpo	Requeridos	Tipo	Descrição
domain	sim	String (FQDN ou IP)	Nome de domínio totalmente qualificado ("FQDN") ou endereço IP
plan	Não	String (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)
catchall	Não	String (endereços de e-mail delimitados) ou Booleano	Crie 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_protection	Não	boleano	Se deve ativar a proteção de conteúdo adulto do Spam Scanner neste domínio
has_phishing_protection	Não	boleano	Se a proteção contra phishing do Spam Scanner deve ser habilitada neste domínio
has_executable_protection	Não	boleano	Se deve habilitar a proteção executável do Spam Scanner neste domínio
has_virus_protection	Não	boleano	Se deve habilitar a proteção contra vírus do Spam Scanner neste domínio
has_recipient_verification	Não	boleano	Padrã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 corpo	Requeridos	Tipo	Descrição
smtp_port	Não	String ou Number	Porta personalizada para configurar para encaminhamento SMTP (o padrão é "25")
has_adult_content_protection	Não	boleano	Se deve ativar a proteção de conteúdo adulto do Spam Scanner neste domínio
has_phishing_protection	Não	boleano	Se a proteção contra phishing do Spam Scanner deve ser habilitada neste domínio
has_executable_protection	Não	boleano	Se deve habilitar a proteção executável do Spam Scanner neste domínio
has_virus_protection	Não	boleano	Se deve habilitar a proteção contra vírus do Spam Scanner neste domínio
has_recipient_verification	Não	boleano	Padrã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 corpo	Requeridos	Tipo	Descrição
email	sim	String (Email)	Endereço de email para convidar para a lista de membros do domínio
group	sim	String (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 corpo	Requeridos	Tipo	Descrição
email	sim	String (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 corpo	Requeridos	Tipo	Descrição
group	sim	String (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 consulta	Requeridos	Tipo	Descrição
name	Não	String (suportado por RegExp)	Pesquise aliases em um domínio por nome
recipient	Não	String (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 corpo	Requeridos	Tipo	Descrição
name	sim	Corda	Nome alternativo
recipients	sim	Sequência ou matriz	Lista 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)
description	Não	Corda	Descrição do alias
labels	Não	Sequência ou matriz	Lista de etiquetas (deve ser String ou Matriz separadas por quebra de linha / espaço / vírgula)
has_recipient_verification	Não	boleano	Se 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_enabled	Não	boleano	Se 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 corpo	Requeridos	Tipo	Descrição
name	Não	Corda	Nome alternativo
recipients	sim	Sequência ou matriz	Lista 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)
description	Não	Corda	Descrição do alias
labels	Não	Sequência ou matriz	Lista de etiquetas (deve ser String ou Matriz separadas por quebra de linha / espaço / vírgula)
has_recipient_verification	Não	boleano	Se 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_enabled	Não	boleano	Se 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: