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.

Accetti la nostra Informativa sulla privacy e i Termini .

Non interessato? Clicca qui per continuare a leggere

Sommario

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 e-mail a api@forwardemail.net se desideri essere avvisato 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 usarle arricciare come negli esempi seguenti.

linguaggioBiblioteca
RubinoFaraday
Pitonerichieste
GiavaOkHttp
PHPgozzovigliare
JavaScriptsuperagente
Nodo.jssuperagente
Partirenet / http
.NETRest Sharp

URI di base

L'attuale percorso dell'URI di base HTTP è: https://api.forwardemail.net. Il percorso URI di base HTTP legacy di https://forwardemail.net:4000 è deprecato a partire dal 1 gennaio 2021.

Autenticazione

Tutti gli endpoint richiedono il tuo Chiave API da impostare come valore "nome utente" della richiesta Autorizzazione di base intestazione. Non preoccuparti: di seguito vengono forniti esempi per te 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.

CodiceNome
200OK
400Brutta richiesta
401non autorizzato
403Vietato
404Non trovato
429Troppe richieste
500Errore interno del server
501Non implementato
502Cattivo gateway
503Servizio non disponibile
504Timeout gateway
Suggerimento: Se ricevi un codice di stato 5xx (cosa che non dovrebbe accadere), contattaci all'indirizzo api@forwardemail.net e ti aiuteremo a risolvere immediatamente il tuo problema.

Localizzazione

Il nostro servizio è tradotto in oltre 25 lingue diverse. Tutti i messaggi di risposta API vengono tradotti nell'ultima locale rilevata dall'utente che effettua la richiesta API. Puoi ignorarlo passando un'abitudine Accept-Language intestazione. Sentiti libero di provarlo usando il menu a discesa della lingua in fondo a questa pagina.

paginatura

Se desideri essere avvisato quando l'impaginazione è disponibile, invia un'e-mail api@forwardemail.net.

account

Creare un profilo

POST /v1/account

Parametro del corponecessariogenereDescrizione
emailString (email)Indirizzo email
passwordCordaParola 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 corponecessariogenereDescrizione
emailNoString (email)Indirizzo email
given_nameNoCordanome di battesimo
family_nameNoCordaCognome
avatar_urlNoStringa (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

Suggerimento: Endpoint di dominio con il nome di un dominio /v1/domains/:domain_name poiché il loro percorso è intercambiabile con l'ID di un dominio :domain_id. Ciò significa che puoi fare riferimento al dominio con i suoi name o id valore.

Elenca domini

GET /v1/domains

Parametro QuerystringnecessariogenereDescrizione
nameNoString (supportato da RegExp)Cerca domini per nome
aliasNoString (supportato da RegExp)Cerca domini per nome alias
recipientNoString (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 corponecessariogenereDescrizione
domainString (FQDN o IP)Nome di dominio completo ("FQDN") o indirizzo IP
planNoString (enumerabile)Tipo di piano (deve essere "free", "enhanced_protection", o "team", per impostazione predefinita "free" o l'attuale piano a pagamento dell'utente se su uno)
catchallNoStringa (indirizzi di posta elettronica delimitati) o booleanoCrea un alias catch-all predefinito, per impostazione predefinita true (Se true utilizzerà l'indirizzo e-mail dell'utente API come destinatario e se false non verrà creato alcun catch-all). Se viene passata una stringa, è un elenco delimitato di indirizzi e-mail da utilizzare come destinatari (separati da interruzione di riga, spazio e/o virgola)
has_adult_content_protectionNobooleanoSe abilitare la protezione dei contenuti per adulti di Spam Scanner su questo dominio
has_phishing_protectionNobooleanoSe abilitare la protezione dal phishing di Spam Scanner su questo dominio
has_executable_protectionNobooleanoSe abilitare la protezione eseguibile di Spam Scanner su questo dominio
has_virus_protectionNobooleanoSe abilitare la protezione antivirus Spam Scanner su questo dominio
has_recipient_verificationNobooleanoImpostazione predefinita del dominio globale per richiedere ai destinatari dell'alias di fare clic su un collegamento di verifica dell'e-mail affinché le e-mail possano fluire

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 corponecessariogenereDescrizione
smtp_portNoStringa o numeroPorta personalizzata da configurare per l'inoltro SMTP (l'impostazione predefinita è "25")
has_adult_content_protectionNobooleanoSe abilitare la protezione dei contenuti per adulti di Spam Scanner su questo dominio
has_phishing_protectionNobooleanoSe abilitare la protezione dal phishing di Spam Scanner su questo dominio
has_executable_protectionNobooleanoSe abilitare la protezione eseguibile di Spam Scanner su questo dominio
has_virus_protectionNobooleanoSe abilitare la protezione antivirus Spam Scanner su questo dominio
has_recipient_verificationNobooleanoImpostazione predefinita del dominio globale per richiedere ai destinatari dell'alias di fare clic su un collegamento di verifica dell'e-mail affinché le e-mail possano fluire

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 corponecessariogenereDescrizione
emailString (email)Indirizzo email da invitare all'elenco dei membri del dominio
groupString (enumerabile)Gruppo con cui aggiungere l'utente all'appartenenza al dominio (può essere uno di "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 corponecessariogenereDescrizione
emailString (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 corponecessariogenereDescrizione
groupString (enumerabile)Gruppo con cui aggiornare l'utente all'appartenenza al dominio (può essere uno di "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

Elenca gli alias di dominio

GET /v1/domains/example.com/aliases

Parametro QuerystringnecessariogenereDescrizione
nameNoString (supportato da RegExp)Cerca gli alias in un dominio in base al nome
recipientNoString (supportato da RegExp)Cerca alias in un dominio in base al destinatario

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 corponecessariogenereDescrizione
nameCordaPseudonimo
recipientsString o ArrayElenco 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)
descriptionNoCordaDescrizione alias
labelsNoString o ArrayElenco di etichette (deve essere un'interruzione di riga / spazio / virgola separati String o Array)
has_recipient_verificationNobooleanoSe abilitare la richiesta ai destinatari di fare clic su un collegamento di verifica dell'e-mail per il flusso delle e-mail (impostazione predefinita sull'impostazione del dominio se non esplicitamente impostata nel corpo della richiesta)
is_enabledNobooleanoSe 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:

Recupera alias di dominio

Puoi recuperare un alias di dominio in entrambi i modi id o il suo name valore.

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

Richiesta di esempio:

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

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

Richiesta di esempio:

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

Aggiorna alias di dominio

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

Parametro del corponecessariogenereDescrizione
nameNoCordaPseudonimo
recipientsString o ArrayElenco 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)
descriptionNoCordaDescrizione alias
labelsNoString o ArrayElenco di etichette (deve essere un'interruzione di riga / spazio / virgola separati String o Array)
has_recipient_verificationNobooleanoSe abilitare la richiesta ai destinatari di fare clic su un collegamento di verifica dell'e-mail per il flusso delle e-mail (impostazione predefinita sull'impostazione del dominio se non esplicitamente impostata nel corpo della richiesta)
is_enabledNobooleanoSe 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: