API-viite

Lähetä sähköpostia

Send transactional mail only from your verified custom domains over HTTPS — password resets, receipts, alerts, and similar event-driven messages. Not for newsletters or marketing bulk. One endpoint, domain-scoped API keys, delivery through AWS SES.

Yleiskatsaus

Päätepistehttps://api.unbox.im/v1/email
MenetelmäPOST
Sisältötyyppiapplication/json
LaajuusYksi API-avain mukautettua verkkotunnusta kohti

Luo avaimet kohdassa Tili → Verkkotunnukset → verkkotunnuksesi → API, kun DNS-vahvistus on valmis. Koko salaisuus näytetään kerran — säilytä se turvallisesti. Valinnaiset SMTP-tunnukset samassa Verkkotunnukset-paneelissa noudattavat samoja vain transaktionaalisten sääntöjä.

Vain transaktionaaliset sähköpostit

Unbox HTTP API (POST /v1/email) and optional SMTP submission are for transactional mail only — messages tied to an account action, purchase, or operational event. They are not a newsletter or marketing broadcast service.

Sallitut käyttötavat

  • Tilin vahvistus, salasanan nollaukset ja turvallisuushälytykset
  • Tilausvahvistukset, kuitit, toimituspäivitykset ja maksuilmoitukset
  • Ilmoitukset, jotka käynnistää tietty käyttäjä tai järjestelmätapahtuma
  • Tiimi- ja työtilaviestit (kutsut, tehtävät, sisäiset hälytykset)

Kielletyt käyttötavat

  • Uutiskirjeet, mainoskampanjat tai joukkosähköpostimarkkinointi
  • Kylmät yhteydenotot tai viestit ostetuille, kerätyille tai luvattomille listoille
  • Kumppanuusroskaposti, tietojenkalastelu tai harhaanjohtava sisältö
  • Kaikki yritykset kiertää vastaanottajarajoja, nopeusrajoituksia tai suunnitelman kiintiöitä

Nopeus- ja vastaanottajarajoitukset

Vastaanottajien ja toimitusvarmuuden suojaamiseksi lähtevää API- ja SMTP-liikennettä koskevat alla olevat rajoitukset (suunnitelman kuukausittaisen lähtevän liikenteen kiintiön lisäksi). Valvonta on käytössä verkkokirjoittimessa, HTTP API:ssa ja SMTP-lähetyksissä. Verkkokirjoitin varoittaa, kun vastaanottajia on yli 25 viestiä kohden, ja estää lähetykset yli 50 vastaanottajalla.

RajaArvo
Vastaanottajia viestiä kohdenEnintään 50 yhteensä (Vastaanottaja + Kopio + Piilokopio yhteensä)
Yksilöllisiä vastaanottajia päivässäEnintään 1 000 työtilaa kohden
Lähetyspyyntöjen nopeusEnintään 10 API- tai SMTP-lähetystä minuutissa domeenia kohden
Suunnitelman lähtevän liikenteen kiintiöTilauksesi kuukausittaiset lähetysrajoitukset ovat edelleen voimassa

Nämä säännöt ovat osa hyväksyttävän käytön käytäntöämme. Automaattinen valvonta on käytössä verkkokirjoittimessa, HTTP API:ssa ja SMTP-lähetyksissä. Tilit, jotka lähettävät markkinointi- tai joukkosähköpostia tai muuten väärinkäyttävät lähetysinfrastruktuuria, voidaan hidastaa, keskeyttää tai lopettaa.

Seuraamme toimitusvarmuussignaaleja. Pysyvä palautusprosentti yli 3 % tai valitusprosentti yli 0,1 % voi aiheuttaa väliaikaisen lähetystauon tai manuaalisen tarkastuksen.

Katso täydelliset käytäntötiedot palveluehdoistamme, tietosuojakäytännöstämme ja GDPR-lausunnostamme.

Todennus

Lähetä verkkotunnuksesi API-avain jokaisessa pyynnössä:

Authorization: Bearer ubk_live_xxxxxxxxxxxxxxxxxxxxxxxx

Vaihtoehtoisesti käytä X-Api-Key: ubk_live_…. Avaimet tallennetaan tiivistettyinä; peruuta tai vaihda ne Verkkotunnukset-koontinäkymästä.

Pyynnön runko

JSON PascalCase-kenttien nimillä (From, To, …). Myös camelCase-aliakset hyväksytään.

KenttäPakollinenKuvaus
FromKylläLähettäjä — henkilökohtainen postilaatikkosi avaimen verkkotunnuksella (ensisijainen tai alias). Jaetut jonot eivät ole kelvollisia lähettäjiä.
ToKylläVastaanottaja(t) — merkkijono, pilkulla eroteltu merkkijono tai taulukko
SubjectKylläAihe
TextBodyJoko TextBody tai HtmlBodyPelkkä tekstisisältö
HtmlBodyJoko TextBody tai HtmlBodyHTML-sisältö
CcEiKopion vastaanottajat
BccEiPiilokopion vastaanottajat
ReplyToEiVastausosoite
TagEiValinnainen metatietotunniste (tallennetaan lähetyksen yhteydessä)

Esimerkki

{
  "From": "you@yourdomain.com",
  "To": "user@example.com",
  "Subject": "Welcome",
  "TextBody": "Thanks for signing up.",
  "HtmlBody": "<p>Thanks for signing up.</p>",
  "ReplyTo": "you@yourdomain.com",
  "Tag": "welcome"
}

Onnistunut vastaus

HTTP 200 JSON-muodossa:

{
  "ErrorCode": 0,
  "Message": "OK",
  "MessageID": "0100018…-000000-…",
  "SubmittedAt": "2026-06-23T12:00:00.000Z",
  "To": "user@example.com"
}

Virhevastaukset

Virheet palauttavat 4xx (tai 500 odottamattomissa virheissä) JSON-muodossa:

{
  "ErrorCode": 300,
  "Message": "TextBody or HtmlBody is required."
}
VirhekoodiMerkitys
0Onnistui
10API-avain puuttuu
11Virheellinen tai peruutettu avain, tai verkkotunnusta ei ole vahvistettu lähetykselle
300Validointivirhe (puuttuvat kentät, virheellinen JSON jne.)
403Lähettäjäosoite ei sallittu — täytyy olla henkilökohtainen postilaatikkosi avaimen verkkotunnuksella
406SES hylkäsi viestin

Esimerkit

Korvaa you@yourdomain.com henkilökohtaisella postilaatikollasi verkkotunnuksella ja käytä omaa API-avaintasi.

curl "https://api.unbox.im/v1/email" \
  -H "Authorization: Bearer ubk_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "From": "you@yourdomain.com",
  "To": "user@example.com",
  "Subject": "Welcome",
  "TextBody": "Thanks for signing up.",
  "HtmlBody": "<p>Thanks for signing up.</p>",
  "ReplyTo": "you@yourdomain.com",
  "Tag": "welcome"
}'

Aloitus

  1. Luo Unbox-tili ja lisää oma verkkotunnuksesi.
  2. Suorita kaikki DNS-vahvistusvaiheet Domains-osiossa.
  3. Avaa Domains → oma verkkotunnus → API ja luo verkkotunnusavain.
  4. Lähetä ensimmäinen viestisi yllä olevien esimerkkien avulla.
Unbox — API-dokumentaatio | Unbox.im