Behöver du dokument med verkliga data och nycklar?
Registrera dig helt enkelt eller logga in för att få dina API-nycklar och faktiska kontodata fyllda nedan.
Vi skapade ett API för programmatisk åtkomst till domäner, alias och mer.
API-dokumentation
Programmatisk åtkomst till dina dataE-post vidarebefordra API
Innehållsförteckning
- bibliotek
- Bas URI
- autentisering
- fel
- Lokalisering
- Paginering
- konto
- domäner
- Inbjudningskort
- medlemmar
- alias
bibliotek
Just nu har vi ännu inte släppt några API-omslag, men vi planerar att göra det inom en snar framtid. Skicka ett mail tillapi@forwardemail.net om du vill bli meddelad när API-wrapper för ett visst programmeringsspråk släpps. Under tiden kan du använda dessa rekommenderade HTTP-förfrågningsbibliotek i din applikation eller helt enkelt användaringla som i exemplen nedan.
Språk | Bibliotek |
---|---|
Rubin | Faraday |
Pytonorm | förfrågningar |
Java | OkHttp |
PHP | SUPA |
JavaScript | superagent |
Node.js | superagent |
Gå | net / http |
.NETTO | RestSharp |
Bas URI
Den nuvarande URI-sökvägen för HTTP-bas är:https://api.forwardemail.net
. Den äldre HTTP-baserade URI-sökvägenhttps://forwardemail.net:4000
avvecklas från och med den 1 januari 2021.
autentisering
Alla slutpunkter kräver dittAPI key to be set as the "username" value of the request's Grundläggande auktorisation rubrik. Oroa dig inte - exempel nedan ges för dig om du inte är säker på vad det är.
fel
Om några fel uppstår kommer svarstypen för API-begäran att innehålla ett detaljerat felmeddelande.
Koda | namn |
---|---|
200 | OK |
400 | Dålig förfrågan |
401 | Obehörig |
403 | Förbjuden |
404 | Hittades inte |
429 | För många förfrågningar |
500 | internt serverfel |
501 | Ej implementerad |
502 | Dålig gateway |
503 | Tjänsten är inte tillgänglig |
504 | Gateway Time-out |
Lokalisering
Vår tjänst översätts till över 25 olika språk. Alla API-svarsmeddelanden översätts till det senaste landskapet som upptäcktes av användaren som gör API-begäran. Du kan åsidosätta detta genom att skicka en anpassadAccept-Language
rubrik. Testa gärna det med rullgardinsmenyn längst ned på denna sida.
Paginering
Om du vill bli meddelad när paginering är tillgänglig, vänligen mailaapi@forwardemail.net.
konto
Skapa konto
POST /v1/account
Kroppsparameter | Nödvändig | Typ | Beskrivning |
---|---|---|---|
email |
Ja | String (e-post) | E-postadress |
password |
Ja | Sträng | Lösenord |
Exempelförfrågan:
curl -X POST https://api.forwardemail.net/v1/account \
-u API_TOKEN: \
-d "email=user%40gmail.com"
Hämta konto
GET /v1/account
Exempelförfrågan:
curl -X GET https://api.forwardemail.net/v1/account \
-u API_TOKEN:
Uppdatera konto
PUT /v1/account
Kroppsparameter | Nödvändig | Typ | Beskrivning |
---|---|---|---|
email |
Nej | String (e-post) | E-postadress |
given_name |
Nej | Sträng | Förnamn |
family_name |
Nej | Sträng | Efternamn |
avatar_url |
Nej | Sträng (URL) | Länk till avatarbild |
Exempelförfrågan:
curl -X PUT https://api.forwardemail.net/v1/account \
-u API_TOKEN: \
-d "email=user%40gmail.com"
domäner
/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 domäner
GET /v1/domains
Querystring-parameter | Nödvändig | Typ | Beskrivning |
---|---|---|---|
name |
Nej | String (RegExp stöds) | Sök efter domäner efter namn |
alias |
Nej | String (RegExp stöds) | Sök efter domäner efter aliasnamn |
recipient |
Nej | String (RegExp stöds) | Sök efter domäner efter mottagare |
Exempelförfrågan:
curl -X GET https://api.forwardemail.net/v1/domains \
-u API_TOKEN:
Skapa domän
POST /v1/domains
Kroppsparameter | Nödvändig | Typ | Beskrivning |
---|---|---|---|
domain |
Ja | String (FQDN eller IP) | Fullt kvalificerat domännamn ("FQDN") eller IP-adress |
plan |
Nej | Sträng (många) | Plan typ (måste vara"free" ,"enhanced_protection" , eller"team" , är standard till"free" or the user's current paid plan if on one) |
catchall |
Nej | Sträng (avgränsade e-postadresser) eller boolesk | Skapa ett standard-alias, som standardtrue (omtrue det kommer att använda API-användarens e-postadress som mottagare, och omfalse ingen fångst kommer att skapas). Om en sträng skickas är det en avgränsad lista över e-postadresser som ska användas som mottagare (åtskilda av radbrytning, mellanslag och / eller komma) |
has_adult_content_protection |
Nej | Boolean | Whether to enable Spam Scanner adult content protection on this domain |
has_phishing_protection |
Nej | Boolean | Whether to enable Spam Scanner phishing protection on this domain |
has_executable_protection |
Nej | Boolean | Whether to enable Spam Scanner executable protection on this domain |
has_virus_protection |
Nej | Boolean | Whether to enable Spam Scanner virus protection on this domain |
has_recipient_verification |
Nej | Boolean | Global domain default for whether to require alias recipients to click an email verification link for emails to flow through |
Exempelförfrågan:
curl -X POST https://api.forwardemail.net/v1/domains \
-u API_TOKEN: \
-d domain=example.com \
-d plan=free
Hämta domän
GET /v1/domains/example.com
Exempelförfrågan:
curl -X GET https://api.forwardemail.net/v1/domains/example.com \
-u API_TOKEN:
Verifiera domänregister
GET /v1/domains/example.com/verify-records
Exempelförfrågan:
curl -X GET https://api.forwardemail.net/v1/domains/example.com/verify-records \
-u API_TOKEN:
Uppdatera domän
PUT /v1/domains/example.com
Kroppsparameter | Nödvändig | Typ | Beskrivning |
---|---|---|---|
smtp_port |
Nej | Sträng eller nummer | Anpassad port för att konfigurera för SMTP-vidarebefordran (standard är"25" ) |
has_adult_content_protection |
Nej | Boolean | Whether to enable Spam Scanner adult content protection on this domain |
has_phishing_protection |
Nej | Boolean | Whether to enable Spam Scanner phishing protection on this domain |
has_executable_protection |
Nej | Boolean | Whether to enable Spam Scanner executable protection on this domain |
has_virus_protection |
Nej | Boolean | Whether to enable Spam Scanner virus protection on this domain |
has_recipient_verification |
Nej | Boolean | Global domain default for whether to require alias recipients to click an email verification link for emails to flow through |
Exempelförfrågan:
curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
-u API_TOKEN:
Radera domän
DELETE /v1/domains/:domain_name
Exempelförfrågan:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
-u API_TOKEN:
Inbjudningskort
Acceptera domäninbjudan
GET /v1/domains/:domain_name/invites
Exempelförfrågan:
curl -X GET https://api.forwardemail.net/v1/domains/:domain_name/invites \
-u API_TOKEN:
Skapa domäninbjudan
POST /v1/domains/example.com/invites
Kroppsparameter | Nödvändig | Typ | Beskrivning |
---|---|---|---|
email |
Ja | String (e-post) | E-postadress för att bjuda in till listan med domänmedlemmar |
group |
Ja | Sträng (många) | Gruppera för att lägga till användaren till domänmedlemskapet med (kan vara en av"admin" eller"user" ) |
Exempelförfrågan:
curl -X POST https://api.forwardemail.net/v1/domains/example.com/invites \
-u API_TOKEN: \
-d "email=user%40gmail.com" \
-d group=admin
Ta bort domäninbjudan
DELETE /v1/domains/:domain_name/invites
Kroppsparameter | Nödvändig | Typ | Beskrivning |
---|---|---|---|
email |
Ja | String (e-post) | E-postadress som ska tas bort från listan över domänmedlemmar |
Exempelförfrågan:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
-u API_TOKEN:
medlemmar
Uppdatera domänmedlem
PUT /v1/domains/example.com/members/:member_id
Kroppsparameter | Nödvändig | Typ | Beskrivning |
---|---|---|---|
group |
Ja | Sträng (många) | Gruppera för att uppdatera användaren till domänmedlemskapet med (kan vara en av"admin" eller"user" ) |
Exempelförfrågan:
curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
-u API_TOKEN:
Ta bort domänmedlem
DELETE /v1/domains/:domain_name/members/:member_id
Exempelförfrågan:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/members/:member_id \
-u API_TOKEN:
alias
Lista domänalias
GET /v1/domains/example.com/aliases
Querystring-parameter | Nödvändig | Typ | Beskrivning |
---|---|---|---|
name |
Nej | String (RegExp stöds) | Sök efter alias i en domän efter namn |
recipient |
Nej | String (RegExp stöds) | Sök efter alias i en domän efter mottagare |
Exempelförfrågan:
curl -X GET https://api.forwardemail.net/v1/domains/example.com/aliases \
-u API_TOKEN:
Skapa nytt domänalias
POST /v1/domains/example.com/aliases
Kroppsparameter | Nödvändig | Typ | Beskrivning |
---|---|---|---|
name |
Ja | Sträng | Alias namn |
recipients |
Ja | Sträng eller array | Lista över mottagare (måste vara radbrytning / mellanslag / kommaseparerad sträng eller array med giltiga e-postadresser, fullt kvalificerade domännamn ("FQDN"), IP-adresser och / eller webbhook-webbadresser) |
description |
Nej | Sträng | Alias beskrivning |
labels |
Nej | Sträng eller array | Lista över etiketter (måste vara radbrytning / mellanslag / kommaseparerad sträng eller array) |
has_recipient_verification |
Nej | Boolean | Whether to enable to require recipients to click an email verification link for emails to flow through (defaults to the domain's setting if not explicitly set in the request body) |
is_enabled |
Nej | Boolean | Huruvida att aktivera detta alias (om det är inaktiverat kommer e-postmeddelanden att dirigeras ingenstans men returnera framgångsrika statuskoder) |
Exempelförfrågan:
curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
-u API_TOKEN:
Hämta domänalias
Du kan hämta ett domänalias med antingen dessid
eller dessname
värde.
GET /v1/domains/:domain_name/aliases/:alias_id
Exempelförfrågan:
curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
-u API_TOKEN:
GET /v1/domains/:domain_name/aliases/:alias_name
Exempelförfrågan:
curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_name \
-u API_TOKEN:
Uppdatera domänalias
PUT /v1/domains/example.com/aliases/:alias_id
Kroppsparameter | Nödvändig | Typ | Beskrivning |
---|---|---|---|
name |
Nej | Sträng | Alias namn |
recipients |
Ja | Sträng eller array | Lista över mottagare (måste vara radbrytning / mellanslag / kommaseparerad sträng eller array med giltiga e-postadresser, fullt kvalificerade domännamn ("FQDN"), IP-adresser och / eller webbhook-webbadresser) |
description |
Nej | Sträng | Alias beskrivning |
labels |
Nej | Sträng eller array | Lista över etiketter (måste vara radbrytning / mellanslag / kommaseparerad sträng eller array) |
has_recipient_verification |
Nej | Boolean | Whether to enable to require recipients to click an email verification link for emails to flow through (defaults to the domain's setting if not explicitly set in the request body) |
is_enabled |
Nej | Boolean | Huruvida att aktivera detta alias (om det är inaktiverat kommer e-postmeddelanden att dirigeras ingenstans men returnera framgångsrika statuskoder) |
Exempelförfrågan:
curl -X PUT https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id \
-u API_TOKEN:
Radera domänalias
DELETE /v1/domains/:domain_name/aliases/:alias_id
Exempelförfrågan:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
-u API_TOKEN: