Need docs with real data and keys?

Simply sign up or log in to have your API keys and real account data populated below.

Læs vores fortrolighedspolitik og vilkår

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

We created an API for programmatic access to domains, aliases, and more.

API Documentation

Programmatic access to your data

API til videresendelse af e-mail

Indholdsfortegnelse

Biblioteker

Lige nu har vi endnu ikke frigivet nogen API-indpakninger, men vi planlægger at gøre det i den nærmeste fremtid. Send en e-mail tilapi@forwardemail.net hvis du vil have besked, når API-indpakningen til et bestemt programmeringssprog frigives. I mellemtiden kan du bruge disse anbefalede HTTP-anmodningsbiblioteker i din applikation eller bare brugekrølle som i nedenstående eksempler.

Sprog Bibliotek
Rubin Faraday
Python anmodninger
Java OkHttp
PHP dyse
JavaScript superagent
Node.js superagent
net / http
.NET RestSharp

Base URI

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

Godkendelse

Alle slutpunkter kræver dingratis API-nøgle : tada: skal indstilles som "brugernavn" -værdien af anmodningensGrundlæggende tilladelse header. Bare rolig - eksempler findes nedenfor for dig, hvis du ikke er sikker på, hvad dette er.

Fejl

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

Kode Navn
200 Okay
400 Dårlig anmodning
401 Uberettiget
403 Forbudt
404 Ikke fundet
429 For mange anmodninger
500 Intern serverfejl
501 Ikke implementeret
502 Bad Gateway
503 Service ikke tilgængelig
504 Gateway Time-out
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.

Lokalisering

Vores service er oversat til over 25 forskellige sprog. Alle API-svarmeddelelser oversættes til det sidst registrerede sted for brugeren, der fremsætter API-anmodningen. Du kan tilsidesætte dette ved at sende en brugerdefineretAccept-Language header. Du er velkommen til at prøve det ved hjælp af rullemenuen sprog nederst på denne side.

Paginering

Hvis du vil have besked, når paginering er tilgængelig, bedes du e-maileapi@forwardemail.net.

Konto

Opret konto

POST /v1/account

Kropsparameter Påkrævet Type Beskrivelse
email Ja Streng (e-mail) Email adresse
password Ja Snor Adgangskode

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

Kropsparameter Påkrævet Type Beskrivelse
email Ingen Streng (e-mail) Email adresse
given_name Ingen Snor Fornavn
family_name Ingen Snor Efternavn
avatar_url Ingen String (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: 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.

Liste domæner

GET /v1/domains

Forespørgselsparameter Påkrævet Type Beskrivelse
name Ingen String (RegExp understøttet) Søg efter domæner efter navn
alias Ingen String (RegExp understøttet) Søg efter domæner efter aliasnavn
recipient Ingen String (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

Kropsparameter Påkrævet Type Beskrivelse
domain Ja Streng (FQDN eller IP) Fuldt kvalificeret domænenavn ("FQDN") eller IP-adresse
plan Ingen Streng (kan tælles) Plan type (skal være"free","enhanced_protection", eller"team", er standard til"free")
catchall Ingen String (afgrænset e-mail-adresse) eller boolsk Opret et standardfang-alias, som standardtrue (hvistrue det bruger API-brugerens e-mail-adresse som modtager, og hvisfalse ingen fangst-alt oprettes). Hvis en streng sendes, er det en afgrænset liste over e-mail-adresser, der skal bruges som modtagere (adskilt af linjeskift, mellemrum og / eller komma)

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

Kropsparameter Påkrævet Type Beskrivelse
smtp_port Ingen Streng eller nummer Brugerdefineret port, der skal konfigureres til SMTP-videresendelse (standard er"25")

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

Kropsparameter Påkrævet Type Beskrivelse
email Ja Streng (e-mail) E-mail-adresse, der skal inviteres til domænemedlemslisten
group Ja Streng (kan tælles) Gruppe, hvor brugeren kan føjes til domænet medlemskab 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

Kropsparameter Påkrævet Type Beskrivelse
email Ja Streng (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

Kropsparameter Påkrævet Type Beskrivelse
group Ja Streng (kan tælles) Gruppe til at opdatere brugeren til domæne medlemskab 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

Hent domænealiaser

GET /v1/domains/example.com/aliases

Forespørgselsparameter Påkrævet Type Beskrivelse
name Ingen String (RegExp understøttet) Søg efter aliasser i et domæne efter navn
recipient Ingen String (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

Kropsparameter Påkrævet Type Beskrivelse
name Ja Snor Alias navn
recipients Ja String eller Array Liste 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)
description Ingen Snor Alias beskrivelse
labels Ingen String eller Array Liste over etiketter (skal være linjeskift / mellemrum / komma-adskilt streng eller matrix)
is_enabled Ingen Boolsk Om 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:

Opdater domænealias

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

Kropsparameter Påkrævet Type Beskrivelse
name Ingen Snor Alias navn
recipients Ja String eller Array Liste 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)
description Ingen Snor Alias beskrivelse
labels Ingen String eller Array Liste over etiketter (skal være linjeskift / mellemrum / komma-adskilt streng eller matrix)
is_enabled Ingen Boolsk Om 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: