Hai bisogno di documenti con dati e chiavi reali?

Basta registrarsi o accedere per avere le chiavi API e i dati dell'account reale popolati di seguito.

Leggi la nostra politica sulla privacy e i termini

Non interessato? Clicca qui per continuare a leggere

Abbiamo creato un'API per l'accesso programmatico a domini, alias e altro.

🤖

Documentazione API

Accesso programmatico ai tuoi dati

API di inoltro email

Sommario

biblioteche

Al momento non abbiamo ancora rilasciato alcun wrapper API, ma prevediamo di farlo nel prossimo futuro. Invia una mail aapi@forwardemail.net se desideri ricevere una notifica quando viene rilasciato il wrapper API di un particolare linguaggio di programmazione. Nel frattempo, puoi utilizzare queste librerie di richieste HTTP consigliate nella tua applicazione o semplicemente usarearricciare come negli esempi seguenti.

linguaggio Biblioteca
Rubino Faraday
Pitone richieste
Giava OkHttp
PHP gozzovigliare
JavaScript superagente
Node.js superagente
Partire net / http
.NETTO RestSharp

URI di base

Il percorso URI di base HTTP corrente è:https://api.forwardemail.net. Il percorso URI di base HTTP legacy dihttps://forwardemail.net:4000 sarà deprecato il 1 ° gennaio 2021.

Autenticazione

Tutti gli endpoint richiedono il tuochiave API gratuita 🎉 to be set as the "username" value of the request's Autorizzazione di base intestazione. Non preoccuparti: di seguito sono riportati degli esempi se non sei sicuro di cosa si tratti.

Errori

Se si verificano errori, il corpo della risposta della richiesta API conterrà un messaggio di errore dettagliato. Oltre ad avere oltre dieci anni di esperienza nella scrittura di API e nella loro documentazione, sono stati ispiratiStrisce beautiful API documentation when we crafted ours 😄.

Codice Nome
200 ok
400 Brutta richiesta
401 non autorizzato
403 Vietato
404 Non trovato
429 Troppe richieste
500 Errore interno del server
501 Non implementato
502 Bad Gateway
503 Servizio non disponibile
504 Timeout gateway
Tip: If you receive a 5xx status code (which should not happen), then please contact us at api@forwardemail.net and we will help you to resolve your issue immediately.

Localizzazione

Il nostro servizio è tradotto in oltre 25 lingue diverse. Tutti i messaggi di risposta API vengono tradotti nell'ultima localizzazione rilevata dall'utente che ha effettuato la richiesta API. Puoi ignorarlo passando un'abitudineAccept-Language intestazione. Sentiti libero di provarlo usando il menu a discesa nella parte inferiore di questa pagina.

paginatura

Se desideri ricevere una notifica quando è disponibile l'impaginazione, invia un'e-mailapi@forwardemail.net.

account

Creare un profilo

POST /v1/account

Parametro del corpo necessario genere Descrizione
email sì String (email) Indirizzo email
password sì Corda Parola d'ordine

Richiesta di esempio:

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

Recupera account

GET /v1/account

Richiesta di esempio:

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

Aggiorna account

PUT /v1/account

Parametro del corpo necessario genere Descrizione
email No String (email) Indirizzo email
given_name No Corda nome di battesimo
family_name No Corda Cognome
avatar_url No Stringa (URL) Link all'immagine avatar

Richiesta di esempio:

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

domini

Tip: Domain endpoints with a domain's name /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.

Elenca domini

GET /v1/domains

Parametro Querystring necessario genere Descrizione
name No String (supportato da RegExp) Cerca domini per nome
alias No String (supportato da RegExp) Cerca domini per nome alias
recipient No String (supportato da RegExp) Cerca domini per destinatario

Richiesta di esempio:

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

Crea dominio

POST /v1/domains

Parametro del corpo necessario genere Descrizione
domain sì String (FQDN o IP) Nome di dominio completo ("FQDN") o indirizzo IP
plan No String (enumerabile) Tipo di piano (deve essere"free","enhanced_protection", o"team", il valore predefinito è"free")
catchall No Stringa (indirizzi di posta elettronica delimitati) o booleano Crea un alias catch-all predefinito, il valore predefinito ètrue (Setrue utilizzerà l'indirizzo e-mail dell'utente API come destinatario e sefalse non verrà creato alcun catch-all). Se viene passata una stringa, si tratta di un elenco delimitato di indirizzi e-mail da utilizzare come destinatari (separati da interruzione di riga, spazio e / o virgola)

Richiesta di esempio:

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

Recupera dominio

GET /v1/domains/example.com

Richiesta di esempio:

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

Verifica i record di dominio

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

Richiesta di esempio:

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

Aggiorna dominio

PUT /v1/domains/example.com

Parametro del corpo necessario genere Descrizione
smtp_port No Stringa o numero Porta personalizzata da configurare per l'inoltro SMTP (impostazione predefinita è"25")

Richiesta di esempio:

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

Elimina dominio

DELETE /v1/domains/:domain_name

Richiesta di esempio:

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

Inviti

Accetta l'invito al dominio

GET /v1/domains/:domain_name/invites

Richiesta di esempio:

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

Crea un invito al dominio

POST /v1/domains/example.com/invites

Parametro del corpo necessario genere Descrizione
email sì String (email) Indirizzo email da invitare all'elenco dei membri del dominio
group sì String (enumerabile) Gruppo con cui aggiungere l'utente all'appartenenza al dominio (può essere uno dei"admin" o"user")

Richiesta di esempio:

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

Rimuovi l'invito al dominio

DELETE /v1/domains/:domain_name/invites

Parametro del corpo necessario genere Descrizione
email sì String (email) Indirizzo e-mail da rimuovere dall'elenco dei membri del dominio

Richiesta di esempio:

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

Membri

Aggiorna membro del dominio

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

Parametro del corpo necessario genere Descrizione
group sì String (enumerabile) Gruppo per aggiornare l'utente con l'appartenenza al dominio (può essere uno dei"admin" o"user")

Richiesta di esempio:

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

Rimuovi membro del dominio

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

Richiesta di esempio:

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

alias

Recupera gli alias di dominio

GET /v1/domains/example.com/aliases

Richiesta di esempio:

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

Crea un nuovo alias di dominio

POST /v1/domains/example.com/aliases

Parametro del corpo necessario genere Descrizione
name sì Corda Pseudonimo
recipients sì String o Array Elenco di destinatari (deve essere una stringa / spazio / virgola separati da stringa o matrice di indirizzi e-mail validi, nomi di dominio completi ("FQDN"), indirizzi IP e / o URL di webhook)
description No Corda Descrizione alias
labels No String o Array Elenco di etichette (deve essere un'interruzione di riga / spazio / virgola separati String o Array)
is_enabled No booleano Se abilitare per disabilitare questo alias (se disabilitato, le e-mail non verranno indirizzate da nessuna parte ma restituiranno codici di stato riusciti)

Richiesta di esempio:

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

Aggiorna alias di dominio

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

Parametro del corpo necessario genere Descrizione
name No Corda Pseudonimo
recipients sì String o Array Elenco di destinatari (deve essere una stringa / spazio / virgola separati da stringa o matrice di indirizzi e-mail validi, nomi di dominio completi ("FQDN"), indirizzi IP e / o URL di webhook)
description No Corda Descrizione alias
labels No String o Array Elenco di etichette (deve essere un'interruzione di riga / spazio / virgola separati String o Array)
is_enabled No booleano Se abilitare per disabilitare questo alias (se disabilitato, le e-mail non verranno indirizzate da nessuna parte ma restituiranno codici di stato riusciti)

Richiesta di esempio:

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

Elimina alias di dominio

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

Richiesta di esempio:

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