Dokumentasjon › API-referanse

API-referanse

Interaktiv referanse. Bla gjennom og prøv hvert endepunkt i den interaktive API-referansen. Den genereres direkte fra API-et, så den er alltid synkronisert. Den maskinlesbare OpenAPI 3-spesifikasjonen ligger på mailhuset.com/openapi.json.

Siden nedenfor er en håndskrevet oversikt. Mailhuset REST-API-et har base-URL https://api.mailhuset.com/v1. Alle forespørsler autentiseres med en Bearer API-nøkkel og sender/returnerer JSON.

Authorization: Bearer $MAILHUSET_API_KEY
Content-Type: application/json

Send e-post

`POST /v1/email`: send en melding. Full feltliste i Send e-post via API-et.

POST /v1/email
{ "from": "Acme <hello@yourdomain.com>", "to": ["a@example.com"], "subject": "Hi", "html": "<p>Hello</p>" }

Meldinger (aktivitet)

`GET /v1/email`: list de siste meldingene med deres status og hendelser, for å bygge din egen aktivitetsvisning eller avstemme sendinger.

Domener

Metode	Sti	Formål
`POST`	`/v1/domains`	Legg til et avsenderdomene
`GET`	`/v1/domains`	List domener og deres status
`GET`	`/v1/domains/{domain}`	Hent ett domene + dets DNS-oppføringer
`POST`	`/v1/domains/{domain}/verify`	Sjekk DNS på nytt og verifiser

Se Verifiser et avsenderdomene.

Webhook-endepunkter

Metode	Sti	Formål
`POST`	`/v1/webhook-endpoints`	Registrer et endepunkt
`GET`	`/v1/webhook-endpoints`	List endepunkter

Hendelsestyper er listet i Webhooks.

Konvensjoner

Versjonering: stien er versjonert (/v1). Nye brytende former får en ny

versjon; additive felt gjør det ikke.

Feil: standard HTTP-statuskoder: 401 (autentisering), 403 (ikke tillatt /

domene ikke verifisert), 422 (validering, med det problematiske feltet), 429 (ratebegrenset). Kropper inkluderer en melding.

Idempotens: send idempotencyKey ved sendinger så gjentakelser ikke sender dobbelt.

Importer spesifikasjonen

OpenAPI-dokumentet på mailhuset.com/openapi.json kan importeres rett inn i verktøyene dine:

Postman / Insomnia: importer via URL for å få en ferdig forespørselsamling.
Klientgenerering: mat den til openapi-generator for å stillasere en klient i

språket ditt.

openapi-generator-cli generate \
  -i https://mailhuset.com/openapi.json \
  -g typescript-fetch -o ./mailhuset-client

Biblioteker

Foretrekker du en typet klient? Bruk Node- og Python-SDK-ene i stedet for rå HTTP.

Trenger du hjelp? Send e-post til support@mailhuset.com.