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 reelle kontodata befolket nedenfor.

Læs vores privatlivspolitik og vilkår

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

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

🤖

API-dokumentation

Programmatisk adgang til dine data

API-videresendelse af e-mail

Indholdsfortegnelse

Biblioteker

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

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

Base URI

Den aktuelle UTP-sti for HTTP-base er:https://api.forwardemail.net. Den ældre HTTP-base URI-sti afhttps://forwardemail.net:4000 afskrives 1. januar 2021.

Godkendelse

Alle slutpunkter kræver ditgratis API-nøgle 🎉 skal indstilles som værdien "brugernavn" på 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 responsorganet i API-anmodningen indeholde en detaljeret fejlmeddelelse. Udover at have over ti års erfaring med at skrive API'er og dokumentere dem, blev du inspireret afStripe s smuk API-dokumentation, da vi lavede vores 😄.

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 er oversat til det sidste landskab, der blev registreret af brugeren, der fremsætter API-anmodning. Du kan tilsidesætte dette ved at videregive en brugerdefineretAccept-Language header. Du kan prøve det ved hjælp af rullemenuen sprog nederst på denne side.

paginering

Hvis du vil have besked, når pagination er tilgængelig, så e-mail venligstapi@forwardemail.net.

Konto

Opret konto

POST /v1/account

Kroppsparameter Nødvendig Type Beskrivelse
email Ja Streng (e-mail) Email adresse
password Ja Snor Adgangskode

Eksempel Anmodning:

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 Anmodning:

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

Example Response:

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

Opdater konto

PUT /v1/account

Kroppsparameter Nødvendig Type Beskrivelse
email Ingen Streng (e-mail) Email adresse
given_name Ingen Snor Fornavn
family_name Ingen Snor Efternavn
avatar_url Ingen Streng (URL) Link til avatarbillede

Eksempel Anmodning:

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."
}

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 over domæner

GET /v1/domains

Querystring-parameter Nødvendig Type Beskrivelse
name Ingen String (RegExp understøttet) Søg efter domæner med 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 Anmodning:

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

Example Response:

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

Opret domæne

POST /v1/domains

Kroppsparameter Nødvendig Type Beskrivelse
domain Ja String (FQDN eller IP) Fuldt kvalificeret domænenavn ("FQDN") eller IP-adresse
plan Ingen Streng (tæller) Plan type (skal være"free","enhanced_protection", eller"team", er standard til"free")
catchall Ingen 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 Anmodning:

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 domæne

GET /v1/domains/example.com

Eksempel Anmodning:

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

Example Response:

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

Bekræft domæneposter

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

Eksempel Anmodning:

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."
}

Opdater domæne

PUT /v1/domains/example.com

Kroppsparameter Nødvendig Type Beskrivelse
smtp_port Ingen Streng eller nummer Brugerdefineret port, der skal konfigureres til SMTP-videresendelse (standard er"25")

Eksempel Anmodning:

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

Example Response:

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

Slet domæne

DELETE /v1/domains/:domain_name

Eksempel Anmodning:

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

Inviterede

Accepter domæneinvitation

GET /v1/domains/:domain_name/invites

Eksempel 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

Kroppsparameter Nødvendig Type Beskrivelse
email Ja Streng (e-mail) E-mail-adresse, der skal inviteres til listen over domænemedlemmer
group Ja Streng (tæller) Grupper for at tilføje brugeren til domænemedlemskabet med (kan være en af"admin" eller"user")

Eksempel Anmodning:

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 domæneinvitation

DELETE /v1/domains/:domain_name/invites

Kroppsparameter Nødvendig Type Beskrivelse
email Ja Streng (e-mail) E-mail-adresse, der skal fjernes fra listen over domænemedlemmer

Eksempel Anmodning:

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

Medlemmer

Opdater domænemedlem

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

Kroppsparameter Nødvendig Type Beskrivelse
group Ja Streng (tæller) Grupper for at opdatere brugeren til domænemedlemskab med (kan være en af"admin" eller"user")

Eksempel Anmodning:

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

Fjern domænemedlem

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

Eksempel Anmodning:

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

aliasser

Hent domænealiaser

GET /v1/domains/example.com/aliases

Eksempel Anmodning:

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."
}

Opret nyt domænealias

POST /v1/domains/example.com/aliases

Kroppsparameter Nødvendig Type Beskrivelse
name Ja Snor Alias navn
recipients Ja String eller Array Liste over modtagere (skal være linjeskift / mellemrum / kommasepareret streng eller array 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 / kommasepareret streng eller array)
is_enabled Ingen Boolean Hvorvidt dette alias skal deaktiveres (hvis deaktiveret, vil e-mails blive dirigeret intetsteds men returnere vellykkede statuskoder)

Eksempel Anmodning:

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."
}

Opdater domænealias

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

Kroppsparameter Nødvendig Type Beskrivelse
name Ingen Snor Alias navn
recipients Ja String eller Array Liste over modtagere (skal være linjeskift / mellemrum / kommasepareret streng eller array 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 / kommasepareret streng eller array)
is_enabled Ingen Boolean Hvorvidt dette alias skal deaktiveres (hvis deaktiveret, vil e-mails blive dirigeret intetsteds men returnere vellykkede statuskoder)

Eksempel 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 Anmodning:

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