Trenger du dokumenter med ekte data og nøkler?

Bare registrer deg eller logg inn for å ha API-nøkler og virkelige kontodata befolket nedenfor.

Du godtar våre retningslinjer for personvern og vilkår .

Ikke interessert? Klikk her for å fortsette å lese

Innholdsfortegnelse

Vi opprettet en API for programmatisk tilgang til domener, aliaser og mer.

API-dokumentasjon

Programmatisk tilgang til dataene dine

API-videresending av e-post

Innholdsfortegnelse

biblioteker

Akkurat nå har vi ennå ikke gitt ut noen API-innpakninger, men vi planlegger å gjøre det i nær fremtid. Send en e-post til api@forwardemail.net hvis du ønsker å bli varslet når et bestemt programmeringsspråks API-omslag er utgitt. I mellomtiden kan du bruke disse anbefalte HTTP-forespørselsbibliotekene i applikasjonen din, eller ganske enkelt bruke krølle som i eksemplene nedenfor.

SpråkBibliotek
RubinFaraday
Pythonforespørsler
JavaOkHttp
PHPdyse
Javascriptsuperagent
node.jssuperagent
net / http
.NETRestSharp

Base URI

Gjeldende HTTP-base URI-bane er: https://api.forwardemail.net. Den eldre HTTP-base-URI-banen til https://forwardemail.net:4000 er avviklet fra 1. januar 2021.

Godkjenning

Alle endepunkter krever din API-nøkkel settes som "brukernavn"-verdien for forespørselen Grunnleggende autorisasjon Overskrift. Ikke bekymre deg – eksempler er gitt nedenfor for deg hvis du ikke er sikker på hva dette er.

feil

Hvis det oppstår feil, vil svaret på API-forespørselen inneholde en detaljert feilmelding.

KodeNavn
200OK
400Dårlig forespørsel
401uautorisert
403Forbudt
404Ikke funnet
429For mange forespørsler
500intern server feil
501Ikke implementert
502Dårlig gateway
503Tjenesten utilgjengelig
504Gateway Time-out
Tips: Hvis du mottar en 5xx-statuskode (noe som ikke skal skje), vennligst kontakt oss på api@forwardemail.net og vi hjelper deg med å løse problemet umiddelbart.

lokalisering

Tjenesten vår er oversatt til over 25 forskjellige språk. Alle API-svarmeldinger blir oversatt til den siste lokaliteten som ble oppdaget av brukeren som sender API-forespørselen. Du kan overstyre dette ved å sende en egendefinert Accept-Language Overskrift. Prøv den gjerne ved å bruke språkrullegardinmenyen nederst på denne siden.

paginering

Hvis du ønsker å bli varslet når paginering er tilgjengelig, vennligst send en e-post api@forwardemail.net.

Regnskap

Opprett konto

POST /v1/account

KroppsparameterTypeBeskrivelse
emailJaStreng (e-post)Epostadresse
passwordJastringPassord

Eksempel forespørsel:

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

Hent konto

GET /v1/account

Eksempel forespørsel:

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

Oppdater konto

PUT /v1/account

KroppsparameterTypeBeskrivelse
emailNeiStreng (e-post)Epostadresse
given_nameNeistringFornavn
family_nameNeistringEtternavn
avatar_urlNeiStreng (URL)Link til avatarbilde

Eksempel forespørsel:

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

domener

Tips: Domeneendepunkter med et domenenavn /v1/domains/:domain_name siden deres bane kan byttes ut med et domenes ID :domain_id. Dette betyr at du kan referere til domenet ved enten dets name eller id verdi.

Liste domener

GET /v1/domains

Querystring-parameterTypeBeskrivelse
nameNeiString (RegExp støttes)Søk etter domener etter navn
aliasNeiString (RegExp støttes)Søk etter domener etter aliasnavn
recipientNeiString (RegExp støttes)Søk etter domener etter mottaker

Eksempel forespørsel:

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

Opprett domene

POST /v1/domains

KroppsparameterTypeBeskrivelse
domainJaStreng (FQDN eller IP)Fullt kvalifisert domenenavn ("FQDN") eller IP-adresse
planNeiStreng (tallbar)Plantype (må være "free", "enhanced_protection", eller "team", er standard til "free" eller brukerens gjeldende betalte plan hvis på en)
catchallNeiStreng (avgrenset e-postadresse) eller boolskOpprett et standard oppsamlingsalias, standard til true (hvis true den vil bruke API-brukerens e-postadresse som mottaker, og hvis false ingen catch-all vil bli opprettet). Hvis en streng sendes, er det en avgrenset liste over e-postadresser som skal brukes som mottakere (atskilt med linjeskift, mellomrom og/eller komma)
has_adult_content_protectionNeibooleanHvorvidt du skal aktivere Spam Scanner beskyttelse mot voksent innhold på dette domenet
has_phishing_protectionNeibooleanOm du skal aktivere nettfiskingsbeskyttelse for spamskanner på dette domenet
has_executable_protectionNeibooleanHvorvidt du skal aktivere Spam Scanner kjørbar beskyttelse på dette domenet
has_virus_protectionNeibooleanOm du skal aktivere Spam Scanner-virusbeskyttelse på dette domenet
has_recipient_verificationNeibooleanGlobalt domene standard for om aliasmottakere skal kreve å klikke på en e-postbekreftelseslenke for at e-poster skal strømme gjennom

Eksempel forespørsel:

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

Hent domenet

GET /v1/domains/example.com

Eksempel forespørsel:

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

Bekreft domeneregistreringer

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

Eksempel forespørsel:

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

Oppdater domenet

PUT /v1/domains/example.com

KroppsparameterTypeBeskrivelse
smtp_portNeiStreng eller nummerEgendefinert port for å konfigurere for SMTP-videresending (standard er "25")
has_adult_content_protectionNeibooleanHvorvidt du skal aktivere Spam Scanner beskyttelse mot voksent innhold på dette domenet
has_phishing_protectionNeibooleanOm du skal aktivere nettfiskingsbeskyttelse for spamskanner på dette domenet
has_executable_protectionNeibooleanHvorvidt du skal aktivere Spam Scanner kjørbar beskyttelse på dette domenet
has_virus_protectionNeibooleanOm du skal aktivere Spam Scanner-virusbeskyttelse på dette domenet
has_recipient_verificationNeibooleanGlobalt domene standard for om aliasmottakere skal kreve å klikke på en e-postbekreftelseslenke for at e-poster skal strømme gjennom

Eksempel forespørsel:

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

Slett domenet

DELETE /v1/domains/:domain_name

Eksempel forespørsel:

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

inviterer

Godta domeneinvitasjon

GET /v1/domains/:domain_name/invites

Eksempel forespørsel:

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

Opprett domeneinvitasjon

POST /v1/domains/example.com/invites

KroppsparameterTypeBeskrivelse
emailJaStreng (e-post)E-postadresse for å invitere til domenemedlemmelisten
groupJaStreng (tallbar)Gruppe for å legge brukeren til domenemedlemskapet med (kan være en av "admin" eller "user")

Eksempel forespørsel:

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

Fjern domeneinvitasjon

DELETE /v1/domains/:domain_name/invites

KroppsparameterTypeBeskrivelse
emailJaStreng (e-post)E-postadresse du vil fjerne fra listen over domenemedlemmer

Eksempel forespørsel:

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

medlemmer

Oppdater domenemedlem

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

KroppsparameterTypeBeskrivelse
groupJaStreng (tallbar)Gruppe å oppdatere brukeren til domenemedlemskapet med (kan være en av "admin" eller "user")

Eksempel forespørsel:

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

Fjern domenemedlem

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

Eksempel forespørsel:

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

aliaser

List opp domenealiaser

GET /v1/domains/example.com/aliases

Querystring-parameterTypeBeskrivelse
nameNeiString (RegExp støttes)Søk etter aliaser i et domene etter navn
recipientNeiString (RegExp støttes)Søk etter aliaser i et domene etter mottaker

Eksempel forespørsel:

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

Opprett nytt domenealias

POST /v1/domains/example.com/aliases

KroppsparameterTypeBeskrivelse
nameJastringAlias navn
recipientsJaString eller ArrayListe over mottakere (må være linjeskift / mellomrom / komma-separert streng eller utvalg av gyldige e-postadresser, fullt kvalifiserte domenenavn ("FQDN"), IP-adresser og / eller nettadresser til nettkroken)
descriptionNeistringAlias beskrivelse
labelsNeiString eller ArrayListe over etiketter (må være linjeskift / mellomrom / komma separert streng eller matrise)
has_recipient_verificationNeibooleanOm det skal aktiveres for å kreve at mottakerne klikker på en e-postbekreftelseslenke for at e-postene skal strømme gjennom (standardinnstillingen for domenet hvis den ikke er eksplisitt angitt i forespørselens tekst)
is_enabledNeibooleanHvorvidt du vil aktivere å deaktivere dette aliaset (hvis deaktivert, e-postmeldinger vil bli dirigert ingen steder men returnere vellykkede statuskoder)

Eksempel forespørsel:

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

Hent domenealias

Du kan hente et domenealias ved enten dets id eller dens name verdi.

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

Eksempel forespørsel:

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

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

Eksempel forespørsel:

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

Oppdater domenealias

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

KroppsparameterTypeBeskrivelse
nameNeistringAlias navn
recipientsJaString eller ArrayListe over mottakere (må være linjeskift / mellomrom / komma-separert streng eller utvalg av gyldige e-postadresser, fullt kvalifiserte domenenavn ("FQDN"), IP-adresser og / eller nettadresser til nettkroken)
descriptionNeistringAlias beskrivelse
labelsNeiString eller ArrayListe over etiketter (må være linjeskift / mellomrom / komma separert streng eller matrise)
has_recipient_verificationNeibooleanOm det skal aktiveres for å kreve at mottakerne klikker på en e-postbekreftelseslenke for at e-postene skal strømme gjennom (standardinnstillingen for domenet hvis den ikke er eksplisitt angitt i forespørselens tekst)
is_enabledNeibooleanHvorvidt du vil aktivere å deaktivere dette aliaset (hvis deaktivert, e-postmeldinger vil bli dirigert ingen steder men returnere vellykkede statuskoder)

Eksempel forespørsel:

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

Slett domenealias

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

Eksempel forespørsel:

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