Har du brug for dokumenter med rigtige data og nøgler?

Du skal blot tilmelde dig eller logge ind for at få dine API-nøgler og rigtige kontodata udfyldt nedenfor.

Du accepterer vores privatlivspolitik og vilkår .

Ikke interesseret? Klik her for at fortsætte med at læse

Indholdsfortegnelse

Vi oprettede en API til programmatisk adgang til domæner, aliaser og mere.

API dokumentation

Programmatisk adgang til dine data

API til videresendelse af e-mail

Indholdsfortegnelse

Biblioteker

Lige nu har vi endnu ikke udgivet nogen API-indpakning, men vi planlægger at gøre det i den nærmeste fremtid. Send en mail til api@forwardemail.net hvis du gerne vil have besked, når et bestemt programmeringssprogs API-indpakning frigives. I mellemtiden kan du bruge disse anbefalede HTTP-anmodningsbiblioteker i din applikation eller blot bruge krølle som i nedenstående eksempler.

SprogBibliotek
RubinFaraday
Pythonanmodninger
JavaOkHttp
PHPdyse
JavaScriptsuperagent
Node.jssuperagent
net / http
.NETRestSharp

Basis-URI

Den aktuelle HTTP-basis-URI-sti er: https://api.forwardemail.net. Den ældre HTTP-base-URI-sti til https://forwardemail.net:4000 er udfaset fra 1. januar 2021.

Godkendelse

Alle endepunkter kræver din API nøgle skal indstilles som "brugernavn"-værdien for anmodningens Grundlæggende tilladelse header. Bare rolig – eksempler er givet nedenfor til dig, hvis du ikke er sikker på, hvad det er.

Fejl

Hvis der opstår fejl, vil svaret på API-anmodningen indeholde en detaljeret fejlmeddelelse.

KodeNavn
200OK
400Dårlig anmodning
401Uberettiget
403Forbudt
404Ikke fundet
429For mange anmodninger
500Intern serverfejl
501Ikke implementeret
502Bad Gateway
503Service ikke tilgængelig
504Gateway Time-out
Tip: Hvis du modtager en 5xx statuskode (hvilket ikke burde ske), så kontakt os venligst på api@forwardemail.net og vi hjælper dig med at løse dit problem med det samme.

Lokalisering

Vores service er oversat til over 25 forskellige sprog. Alle API-svarmeddelelser oversættes til den sidst registrerede lokalitet for den bruger, der foretager API-anmodningen. Du kan tilsidesætte dette ved at overføre en brugerdefineret Accept-Language header. Du er velkommen til at prøve det ved at bruge sprogrullemenuen nederst på denne side.

Paginering

Hvis du gerne vil have besked, når paginering er tilgængelig, så send en e-mail api@forwardemail.net.

Konto

Opret konto

POST /v1/account

KropsparameterPåkrævetTypeBeskrivelse
emailJaStreng (e-mail)Email adresse
passwordJaSnorAdgangskode

Eksempel på anmodning:

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

Hent konto

GET /v1/account

Eksempel på anmodning:

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

Opdater konto

PUT /v1/account

KropsparameterPåkrævetTypeBeskrivelse
emailIngenStreng (e-mail)Email adresse
given_nameIngenSnorFornavn
family_nameIngenSnorEfternavn
avatar_urlIngenStreng (URL)Link til avatarbillede

Eksempel på anmodning:

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

Domæner

Tip: Domæneendepunkter med et domænenavn /v1/domains/:domain_name da deres sti kan udskiftes med et domænes ID :domain_id. Det betyder, at du kan henvise til domænet ved enten dets name eller id værdi.

Liste domæner

GET /v1/domains

ForespørgselsparameterPåkrævetTypeBeskrivelse
nameIngenString (RegExp understøttet)Søg efter domæner efter navn
aliasIngenString (RegExp understøttet)Søg efter domæner efter aliasnavn
recipientIngenString (RegExp understøttet)Søg efter domæner efter modtager

Eksempel på anmodning:

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

Opret domæne

POST /v1/domains

KropsparameterPåkrævetTypeBeskrivelse
domainJaStreng (FQDN eller IP)Fuldt kvalificeret domænenavn ("FQDN") eller IP-adresse
planIngenStreng (kan tælles)Plantype (skal være "free", "enhanced_protection", eller "team", er standard til "free" eller brugerens nuværende betalte abonnement, hvis på en)
catchallIngenString (afgrænset e-mail-adresse) eller boolskOpret et standard catch-all alias, standard til true (hvis true den vil bruge API-brugerens e-mailadresse som modtager, og hvis false ingen catch-all vil blive oprettet). Hvis en streng sendes, er det en afgrænset liste over e-mailadresser, der skal bruges som modtagere (adskilt af linjeskift, mellemrum og/eller komma)
has_adult_content_protectionIngenBoolskOm spamscanneren skal aktivere beskyttelse af voksenindhold på dette domæne
has_phishing_protectionIngenBoolskOm spamscannerens phishingbeskyttelse skal aktiveres på dette domæne
has_executable_protectionIngenBoolskOm Spam Scanner eksekverbar beskyttelse skal aktiveres på dette domæne
has_virus_protectionIngenBoolskOm spamscanner-virusbeskyttelse skal aktiveres på dette domæne
has_recipient_verificationIngenBoolskGlobalt domæne standard for, om der skal kræves, at aliasmodtagere klikker på et e-mailbekræftelseslink, så e-mails kan flyde igennem

Eksempel på anmodning:

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

Hent domæne

GET /v1/domains/example.com

Eksempel på anmodning:

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

Bekræft domæneregistreringer

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

Eksempel på anmodning:

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

Opdater domæne

PUT /v1/domains/example.com

KropsparameterPåkrævetTypeBeskrivelse
smtp_portIngenStreng eller nummerBrugerdefineret port til at konfigurere til SMTP-videresendelse (standard er "25")
has_adult_content_protectionIngenBoolskOm spamscanneren skal aktivere beskyttelse af voksenindhold på dette domæne
has_phishing_protectionIngenBoolskOm spamscannerens phishingbeskyttelse skal aktiveres på dette domæne
has_executable_protectionIngenBoolskOm Spam Scanner eksekverbar beskyttelse skal aktiveres på dette domæne
has_virus_protectionIngenBoolskOm spamscanner-virusbeskyttelse skal aktiveres på dette domæne
has_recipient_verificationIngenBoolskGlobalt domæne standard for, om der skal kræves, at aliasmodtagere klikker på et e-mailbekræftelseslink, så e-mails kan flyde igennem

Eksempel på anmodning:

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

Slet domæne

DELETE /v1/domains/:domain_name

Eksempel på anmodning:

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

Inviterer

Accepter domæneinvitation

GET /v1/domains/:domain_name/invites

Eksempel på anmodning:

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

Opret domæneinvitation

POST /v1/domains/example.com/invites

KropsparameterPåkrævetTypeBeskrivelse
emailJaStreng (e-mail)E-mail-adresse, der skal inviteres til domænemedlemslisten
groupJaStreng (kan tælles)Gruppe at føje brugeren til domænemedlemskabet med (kan være en af "admin" eller "user")

Eksempel på anmodning:

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

Fjern domæneinvitation

DELETE /v1/domains/:domain_name/invites

KropsparameterPåkrævetTypeBeskrivelse
emailJaStreng (e-mail)E-mail-adresse, der skal fjernes fra domænemedlemslisten

Eksempel på anmodning:

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

Medlemmer

Opdater domæne medlem

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

KropsparameterPåkrævetTypeBeskrivelse
groupJaStreng (kan tælles)Gruppe at opdatere brugeren til domænemedlemskabet med (kan være en af "admin" eller "user")

Eksempel på anmodning:

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

Fjern domæne medlem

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

Eksempel på anmodning:

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

Aliaser

Liste domænealiasser

GET /v1/domains/example.com/aliases

ForespørgselsparameterPåkrævetTypeBeskrivelse
nameIngenString (RegExp understøttet)Søg efter aliasser i et domæne efter navn
recipientIngenString (RegExp understøttet)Søg efter aliasser i et domæne efter modtager

Eksempel på anmodning:

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

Opret nyt domænealias

POST /v1/domains/example.com/aliases

KropsparameterPåkrævetTypeBeskrivelse
nameJaSnorAlias navn
recipientsJaString eller ArrayListe over modtagere (skal være linjeskift / mellemrum / komma-adskilt String eller matrix med gyldige e-mail-adresser, fuldt kvalificerede domænenavne ("FQDN"), IP-adresser og / eller webhook-URL'er)
descriptionIngenSnorAlias beskrivelse
labelsIngenString eller ArrayListe over etiketter (skal være linjeskift / mellemrum / komma-adskilt streng eller matrix)
has_recipient_verificationIngenBoolskOm det skal aktiveres for at kræve, at modtagere klikker på et e-mailbekræftelseslink, så e-mails kan flyde igennem (standardindstillingen for domænet, hvis det ikke udtrykkeligt er angivet i anmodningens brødtekst)
is_enabledIngenBoolskOm dette alias skal deaktiveres (hvis det er deaktiveret, sendes e-mails intetsteds, men returnerer vellykkede statuskoder)

Eksempel på anmodning:

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

Hent domænealias

Du kan hente et domænealias ved enten dets id eller dens name værdi.

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

Eksempel på anmodning:

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

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

Eksempel på anmodning:

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

Opdater domænealias

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

KropsparameterPåkrævetTypeBeskrivelse
nameIngenSnorAlias navn
recipientsJaString eller ArrayListe over modtagere (skal være linjeskift / mellemrum / komma-adskilt String eller matrix med gyldige e-mail-adresser, fuldt kvalificerede domænenavne ("FQDN"), IP-adresser og / eller webhook-URL'er)
descriptionIngenSnorAlias beskrivelse
labelsIngenString eller ArrayListe over etiketter (skal være linjeskift / mellemrum / komma-adskilt streng eller matrix)
has_recipient_verificationIngenBoolskOm det skal aktiveres for at kræve, at modtagere klikker på et e-mailbekræftelseslink, så e-mails kan flyde igennem (standardindstillingen for domænet, hvis det ikke udtrykkeligt er angivet i anmodningens brødtekst)
is_enabledIngenBoolskOm dette alias skal deaktiveres (hvis det er deaktiveret, sendes e-mails intetsteds, men returnerer vellykkede statuskoder)

Eksempel på anmodning:

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

Slet domænealias

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

Eksempel på anmodning:

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