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.

Les våre personvernregler og vilkår

Ikke interessert? Klikk her for å fortsette å lese

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-pakkere, men vi planlegger å gjøre det i løpet av en nær fremtid. Send en e-post tilapi@forwardemail.net hvis du vil bli varslet når API-innpakningen til et bestemt programmeringsspråk blir utgitt. I mellomtiden kan du bruke disse anbefalte HTTP-forespørselbibliotekene i applikasjonen din, eller ganske enkelt brukecurl som i eksemplene nedenfor.

Språk Bibliotek
Rubin Faraday
Python forespørsler
Java OkHttp
PHP guzzle
Javascript superagent
node.js superagent
net / http
.NETT RestSharp

Base URI

Den gjeldende UTP-banen for HTTP-base er:https://api.forwardemail.net. Den arv HTTP base URI banen tilhttps://forwardemail.net:4000 blir avskrevet 1. januar 2021.

Godkjenning

Alle sluttpunkter krever dittgratis API-nøkkel 🎉 for å bli satt som "brukernavn" -verdien til forespørselenGrunnleggende 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 svarorganet for API-forespørselen inneholde en detaljert feilmelding. I tillegg til å ha over ti års erfaring med å skrive API-er og dokumentere dem, ble du inspirert avstripe er vakker API-dokumentasjon da vi laget vår 😄.

Kode Navn
200 OK
400 Dårlig forespørsel
401 uautorisert
403 Forbudt
404 Ikke funnet
429 For mange forespørsler
500 intern server feil
501 Ikke implementert
502 Dårlig gateway
503 Tjenesten utilgjengelig
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

Tjenesten vår er oversatt til over 25 forskjellige språk. Alle API-svarmeldinger blir oversatt til det siste landskapet som ble oppdaget av brukeren som gjør API-forespørselen. Du kan overstyre dette ved å sende en tilpassetAccept-Language Overskrift. Prøv det med bruk av rullegardinmenyen nederst på denne siden.

paginering

Hvis du vil bli varslet når paginering er tilgjengelig, kan du sende en e-postapi@forwardemail.net.

Regnskap

Opprett konto

POST /v1/account

Kroppsparameter Type Beskrivelse
email Ja Streng (e-post) Epostadresse
password Ja string Passord

Eksempel forespørsel:

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

Example Response:

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Password was invalid."
}

Hent konto

GET /v1/account

Eksempel forespørsel:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Oppdater konto

PUT /v1/account

Kroppsparameter Type Beskrivelse
email Nei Streng (e-post) Epostadresse
given_name Nei string Fornavn
family_name Nei string Etternavn
avatar_url Nei Streng (URL) Link til avatarbilde

Eksempel forespørsel:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

domener

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 domener

GET /v1/domains

Querystring-parameter Type Beskrivelse
name Nei String (RegExp støttes) Søk etter domener etter navn
alias Nei String (RegExp støttes) Søk etter domener etter aliasnavn
recipient Nei String (RegExp støttes) Søk etter domener etter mottaker

Eksempel forespørsel:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Opprett domene

POST /v1/domains

Kroppsparameter Type Beskrivelse
domain Ja Streng (FQDN eller IP) Fullt kvalifisert domenenavn ("FQDN") eller IP-adresse
plan Nei Streng (tallbar) Plan type (må være"free","enhanced_protection", eller"team", standard til"free")
catchall Nei String (delimited email addresses) or Boolean Create a default catch-all alias, defaults to true (if true it will use the API user's email address as a recipient, and if false no catch-all will be created). If a String is passed, then it is a delimited list of email addresses to use as recipients (separated by line break, space, and/or comma)

Eksempel forespørsel:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Hent domenet

GET /v1/domains/example.com

Eksempel forespørsel:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid 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:

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Oppdater domenet

PUT /v1/domains/example.com

Kroppsparameter Type Beskrivelse
smtp_port Nei Streng eller nummer Tilpasset port for å konfigurere for SMTP-videresending (standard er"25")

Eksempel forespørsel:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid 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

Kroppsparameter Type Beskrivelse
email Ja Streng (e-post) E-postadresse for å invitere til domenemedlemmelisten
group Ja Streng (tallbar) Grupper 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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Fjern domeneinvitasjon

DELETE /v1/domains/:domain_name/invites

Kroppsparameter Type Beskrivelse
email Ja Streng (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

Kroppsparameter Type Beskrivelse
group Ja Streng (tallbar) Grupper for å 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

Hent domenealiaser

GET /v1/domains/example.com/aliases

Eksempel forespørsel:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Opprett nytt domenealias

POST /v1/domains/example.com/aliases

Kroppsparameter Type Beskrivelse
name Ja string Alias navn
recipients Ja String eller Array Liste 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)
description Nei string Alias beskrivelse
labels Nei String eller Array Liste over etiketter (må være linjeskift / mellomrom / komma separert streng eller matrise)
is_enabled Nei boolean Hvorvidt 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:

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Oppdater domenealias

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

Kroppsparameter Type Beskrivelse
name Nei string Alias navn
recipients Ja String eller Array Liste 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)
description Nei string Alias beskrivelse
labels Nei String eller Array Liste over etiketter (må være linjeskift / mellomrom / komma separert streng eller matrise)
is_enabled Nei boolean Hvorvidt 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: