API-nøkler

API-nøkler autentiserer alle programmatiske forespørsler: sending og administrasjonsendepunktene.

Opprett en nøkkel

Åpne API keys → Create key, gi den et navn (så du kjenner den igjen senere, f.eks. den tjenesten som skal bruke den), og kopier den én gang. Nøkler lagres hashet og vises kun én gang; hvis du mister den, må du tilbakekalle den og opprette en ny.

Behandle nøkler som passord. Lagre dem i plattformens hemmelighetsbehandler, aldri i kildekontroll eller kode på klientsiden.

Bruk den

Send nøkkelen som et Bearer-token:

Authorization: Bearer mh_live_xxxxxxxx

SDK-ene og curl-eksemplene gjennom hele denne dokumentasjonen leser den fra en miljøvariabel som MAILHUSET_API_KEY.

Live- og testnøkler

Hver nøkkel er enten live (mh_live_…) eller test (mh_test_…), valgt når du oppretter den. En testnøkkel kjører i sandbox-modus: forespørsler valideres og registreres i meldingsloggen din nøyaktig som normalt, men e-posten sendes aldri faktisk, så den når aldri en ekte innboks, teller mot kvoten din eller faktureres.

Bruk en testnøkkel til å bygge og teste integrasjonen din ende til ende uten bivirkninger. Bytt til en live-nøkkel når du er klar til å sende på ordentlig. Et helt prosjekt kan også opprettes i sandbox-modus, som tvinger hver nøkkel i det til å oppføre seg på denne måten.

Nøkkelavgrensninger

Begrens hva en nøkkel kan gjøre med scopes:

• email:send: send e-post kun
• email:read: les meldinger, statistikk og hendelser kun
• manage: alt annet (domener, nøkler, webhooks, blokkeringer)

En nøkkel uten scopes har full tilgang (standarden, av bakoverkompatibilitetshensyn). Gi hver integrasjon det smaleste settet den trenger.

Avgrensning

Nøkler er avgrenset til sitt prosjekt, så en staging-nøkkel ikke kan røre produksjon. Opprett separate nøkler per miljø og per integrasjon, så du kan tilbakekalle én uten å forstyrre de andre.

Roter og tilbakekall

Tilbakekall en nøkkel fra den samme siden i det øyeblikket den kan være eksponert; forespørsler med den mislykkes umiddelbart. Å rotere jevnlig er god hygiene: opprett den nye nøkkelen, rull den ut, og tilbakekall deretter den gamle.

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