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.
Criamos uma API para acesso programático a domínios, aliases e muito mais.
Documentação da API
Acesso programático aos seus dadosAPI de encaminhamento de email
Índice
- Bibliotecas
- URI base
- Autenticação
- Erros
- Localização
- Paginação
- Conta
- Domínios
- Convida
- Membros
- Apelido
Bibliotecas
No momento, ainda não lançamos nenhum wrapper de API, mas planejamos fazê-lo em um futuro próximo. Envie um email paraapi@forwardemail.net se você gostaria de ser notificado quando um wrapper de API de uma linguagem de programação específica for lançado. Enquanto isso, você pode usar essas bibliotecas de solicitações HTTP recomendadas em seu aplicativo ou simplesmente usarondulaçã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 |
.INTERNET | RestSharp |
URI base
O caminho atual do URI base HTTP é:https://api.forwardemail.net
. O caminho URI base HTTP herdado dehttps://forwardemail.net:4000
foi suspenso a partir de 1º de janeiro de 2021.
Autenticação
Todos os terminais requerem suachave de API gratuita : tada: a ser definido como o valor "nome de usuário" do pedidoAutorização básica cabeçalho. Não se preocupe - os exemplos são fornecidos abaixo 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 convertidas para o último código de idioma detectado pelo usuário que está fazendo a solicitação da API. Você pode substituir isso passando umAccept-Language
cabeçalho. Sinta-se à vontade para experimentar 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 emailapi@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
/v1/domains/:domain_name
as their path are interchangeable with a domain's ID :domain_id
. This means you can refer to the domain by either its name
or id
value.
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" , o padrão é"free" ) |
catchall |
Não | String (endereços de e-mail delimitados) ou Booleano | Crie um alias padrão, o padrão étrue (E setrue ele usará o endereço de e-mail do usuário da API como destinatário e sefalse nenhum pega-tudo será criado). Se uma string for passada, ela será 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) |
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 a ser configurada para encaminhamento SMTP (o padrão é"25" ) |
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 do 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 ao 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
Recuperar 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) |
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:
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) |
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: