¿Necesita documentos con datos y claves reales?
Simplemente regístrese o inicie sesión para que sus claves API y datos de la cuenta real se completen a continuación.
Creamos una API para acceso programático a dominios, alias y más.
Documentación API
Acceso programático a sus datos.API de reenvío de correo electrónico
Tabla de contenido
- Bibliotecas
- URI base
- Autenticación
- Errores
- Localización
- Paginación
- Cuenta
- Dominios
- Invita
- Miembros
- Alias
Bibliotecas
En este momento aún no hemos lanzado ningún contenedor API, pero planeamos hacerlo en un futuro cercano. Enviar un correo electrónico aapi@forwardemail.net si desea recibir una notificación cuando se lance el contenedor API de un lenguaje de programación en particular. Mientras tanto, puede usar estas bibliotecas de solicitudes HTTP recomendadas en su aplicación, o simplemente usarrizo como en los ejemplos a continuación.
Idioma | Biblioteca |
---|---|
Rubí | Faraday |
Pitón | peticiones |
Java | OkHttp |
PHP | engullir |
JavaScript | superagente |
Node.js | superagente |
Vamos | net / http |
.RED | RestSharp |
URI base
La ruta de URI base HTTP actual es:https://api.forwardemail.net
. La ruta de URI de base HTTP heredada dehttps://forwardemail.net:4000
is deprecated as of January 1, 2021.
Autenticación
Todos los puntos finales requieren suclave API gratuita 🎉 to be set as the "username" value of the request's Autorización Básica encabezamiento. No se preocupe: a continuación se proporcionan ejemplos si no está seguro de qué se trata.
Errores
Si se produce algún error, el cuerpo de respuesta de la solicitud de API contendrá un mensaje de error detallado. Además de tener más de diez años de experiencia escribiendo API y documentando, se inspiraron enRayas beautiful API documentation when we crafted ours 😄.
Código | Nombre |
---|---|
200 | Okay |
400 | Solicitud incorrecta |
401 | No autorizado |
403 | Prohibido |
404 | Extraviado |
429 | Demasiadas solicitudes |
500 | error de servidor interno |
501 | No se ha implementado |
502 | Puerta de enlace incorrecta |
503 | Servicio no disponible |
504 | Tiempo de espera de puerta de enlace |
Localización
Nuestro servicio está traducido a más de 25 idiomas diferentes. Todos los mensajes de respuesta de la API se traducen a la última configuración regional detectada del usuario que realiza la solicitud de la API. Puede anular esto pasando una costumbreAccept-Language
encabezamiento. Siéntase libre de probarlo usando el menú desplegable de idiomas al final de esta página.
Paginación
Si desea recibir una notificación cuando la paginación esté disponible, envíe un correo electrónicoapi@forwardemail.net.
Cuenta
Crear una cuenta
POST /v1/account
Parámetro del cuerpo | Necesario | Tipo | Descripción |
---|---|---|---|
email |
si | Cadena (correo electrónico) | Dirección de correo electrónico |
password |
si | Cuerda | Contraseña |
Solicitud de ejemplo:
curl -X POST https://api.forwardemail.net/v1/account \
-u API_TOKEN: \
-d "email=user%40gmail.com"
Recuperar cuenta
GET /v1/account
Solicitud de ejemplo:
curl -X GET https://api.forwardemail.net/v1/account \
-u API_TOKEN:
Actualizar cuenta
PUT /v1/account
Parámetro del cuerpo | Necesario | Tipo | Descripción |
---|---|---|---|
email |
No | Cadena (correo electrónico) | Dirección de correo electrónico |
given_name |
No | Cuerda | Nombre de pila |
family_name |
No | Cuerda | Apellido |
avatar_url |
No | Cadena (URL) | Enlace a la imagen del avatar |
Solicitud de ejemplo:
curl -X PUT https://api.forwardemail.net/v1/account \
-u API_TOKEN: \
-d "email=user%40gmail.com"
Dominios
/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.
Lista de dominios
GET /v1/domains
Parámetro de Querystring | Necesario | Tipo | Descripción |
---|---|---|---|
name |
No | Cadena (compatible con RegExp) | Buscar dominios por nombre |
alias |
No | Cadena (compatible con RegExp) | Buscar dominios por nombre de alias |
recipient |
No | Cadena (compatible con RegExp) | Buscar dominios por destinatario |
Solicitud de ejemplo:
curl -X GET https://api.forwardemail.net/v1/domains \
-u API_TOKEN:
Crear dominio
POST /v1/domains
Parámetro del cuerpo | Necesario | Tipo | Descripción |
---|---|---|---|
domain |
si | Cadena (FQDN o IP) | Nombre de dominio completo ("FQDN") o dirección IP |
plan |
No | Cadena (enumerable) | Tipo de plan (debe ser"free" ,"enhanced_protection" o"team" , por defecto es"free" ) |
catchall |
No | Cadena (direcciones de correo electrónico delimitadas) o booleano | Cree un alias general predeterminado, el valor predeterminado estrue (Sitrue utilizará la dirección de correo electrónico del usuario de la API como destinatario, y sifalse no se creará ningún comodín). Si se pasa una cadena, entonces es una lista delimitada de direcciones de correo electrónico para usar como destinatarios (separadas por salto de línea, espacio y / o coma) |
Solicitud de ejemplo:
curl -X POST https://api.forwardemail.net/v1/domains \
-u API_TOKEN: \
-d domain=example.com \
-d plan=free
Recuperar dominio
GET /v1/domains/example.com
Solicitud de ejemplo:
curl -X GET https://api.forwardemail.net/v1/domains/example.com \
-u API_TOKEN:
Verificar registros de dominio
GET /v1/domains/example.com/verify-records
Solicitud de ejemplo:
curl -X GET https://api.forwardemail.net/v1/domains/example.com/verify-records \
-u API_TOKEN:
Actualizar dominio
PUT /v1/domains/example.com
Parámetro del cuerpo | Necesario | Tipo | Descripción |
---|---|---|---|
smtp_port |
No | Cadena o número | Puerto personalizado para configurar para el reenvío SMTP (el valor predeterminado es"25" ) |
Solicitud de ejemplo:
curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
-u API_TOKEN:
Eliminar dominio
DELETE /v1/domains/:domain_name
Solicitud de ejemplo:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
-u API_TOKEN:
Invita
Aceptar invitación de dominio
GET /v1/domains/:domain_name/invites
Solicitud de ejemplo:
curl -X GET https://api.forwardemail.net/v1/domains/:domain_name/invites \
-u API_TOKEN:
Crear invitación de dominio
POST /v1/domains/example.com/invites
Parámetro del cuerpo | Necesario | Tipo | Descripción |
---|---|---|---|
email |
si | Cadena (correo electrónico) | Dirección de correo electrónico para invitar a la lista de miembros del dominio |
group |
si | Cadena (enumerable) | Grupo para agregar al usuario a la membresía del dominio (puede ser uno de"admin" o"user" ) |
Solicitud de ejemplo:
curl -X POST https://api.forwardemail.net/v1/domains/example.com/invites \
-u API_TOKEN: \
-d "email=user%40gmail.com" \
-d group=admin
Eliminar invitación de dominio
DELETE /v1/domains/:domain_name/invites
Parámetro del cuerpo | Necesario | Tipo | Descripción |
---|---|---|---|
email |
si | Cadena (correo electrónico) | Dirección de correo electrónico para eliminar de la lista de miembros del dominio |
Solicitud de ejemplo:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
-u API_TOKEN:
Miembros
Actualizar miembro de dominio
PUT /v1/domains/example.com/members/:member_id
Parámetro del cuerpo | Necesario | Tipo | Descripción |
---|---|---|---|
group |
si | Cadena (enumerable) | Grupo para actualizar el usuario a la membresía del dominio (puede ser uno de"admin" o"user" ) |
Solicitud de ejemplo:
curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
-u API_TOKEN:
Eliminar miembro de dominio
DELETE /v1/domains/:domain_name/members/:member_id
Solicitud de ejemplo:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/members/:member_id \
-u API_TOKEN:
Alias
Recuperar alias de dominio
GET /v1/domains/example.com/aliases
Solicitud de ejemplo:
curl -X GET https://api.forwardemail.net/v1/domains/example.com/aliases \
-u API_TOKEN:
Crear nuevo alias de dominio
POST /v1/domains/example.com/aliases
Parámetro del cuerpo | Necesario | Tipo | Descripción |
---|---|---|---|
name |
si | Cuerda | Sobre nombre |
recipients |
si | Cadena o matriz | Lista de destinatarios (debe ser un salto de línea / espacio / coma separados por cadenas o matrices de direcciones de correo electrónico válidas, nombres de dominio completos ("FQDN"), direcciones IP y / o URL de webhook) |
description |
No | Cuerda | Descripción del alias |
labels |
No | Cadena o matriz | Lista de etiquetas (debe ser un salto de línea / espacio / separados por comas de cadena o matriz) |
is_enabled |
No | Booleano | Si se habilita para deshabilitar este alias (si está deshabilitado, los correos electrónicos no se enrutarán a ninguna parte, pero devolverán códigos de estado exitosos) |
Solicitud de ejemplo:
curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
-u API_TOKEN:
Actualizar alias de dominio
PUT /v1/domains/example.com/aliases/:alias_id
Parámetro del cuerpo | Necesario | Tipo | Descripción |
---|---|---|---|
name |
No | Cuerda | Sobre nombre |
recipients |
si | Cadena o matriz | Lista de destinatarios (debe ser un salto de línea / espacio / coma separados por cadenas o matrices de direcciones de correo electrónico válidas, nombres de dominio completos ("FQDN"), direcciones IP y / o URL de webhook) |
description |
No | Cuerda | Descripción del alias |
labels |
No | Cadena o matriz | Lista de etiquetas (debe ser un salto de línea / espacio / separados por comas de cadena o matriz) |
is_enabled |
No | Booleano | Si se habilita para deshabilitar este alias (si está deshabilitado, los correos electrónicos no se enrutarán a ninguna parte, pero devolverán códigos de estado exitosos) |
Solicitud de ejemplo:
curl -X PUT https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id \
-u API_TOKEN:
Eliminar alias de dominio
DELETE /v1/domains/:domain_name/aliases/:alias_id
Solicitud de ejemplo:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
-u API_TOKEN: