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
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.
| Raja | Arvo |
|---|---|
| Vastaanottajia viestiä kohden | Enintään 50 yhteensä (Vastaanottaja + Kopio + Piilokopio yhteensä) |
| Yksilöllisiä vastaanottajia päivässä | Enintään 1 000 työtilaa kohden |
| Lähetyspyyntöjen nopeus | Enintää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_xxxxxxxxxxxxxxxxxxxxxxxxVaihtoehtoisesti 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ä | Pakollinen | Kuvaus |
|---|---|---|
From | Kyllä | Lähettäjä — henkilökohtainen postilaatikkosi avaimen verkkotunnuksella (ensisijainen tai alias). Jaetut jonot eivät ole kelvollisia lähettäjiä. |
To | Kyllä | Vastaanottaja(t) — merkkijono, pilkulla eroteltu merkkijono tai taulukko |
Subject | Kyllä | Aihe |
TextBody | Joko TextBody tai HtmlBody | Pelkkä tekstisisältö |
HtmlBody | Joko TextBody tai HtmlBody | HTML-sisältö |
Cc | Ei | Kopion vastaanottajat |
Bcc | Ei | Piilokopion vastaanottajat |
ReplyTo | Ei | Vastausosoite |
Tag | Ei | Valinnainen 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."
}| Virhekoodi | Merkitys |
|---|---|
0 | Onnistui |
10 | API-avain puuttuu |
11 | Virheellinen tai peruutettu avain, tai verkkotunnusta ei ole vahvistettu lähetykselle |
300 | Validointivirhe (puuttuvat kentät, virheellinen JSON jne.) |
403 | Lähettäjäosoite ei sallittu — täytyy olla henkilökohtainen postilaatikkosi avaimen verkkotunnuksella |
406 | SES 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
- Luo Unbox-tili ja lisää oma verkkotunnuksesi.
- Suorita kaikki DNS-vahvistusvaiheet Domains-osiossa.
- Avaa Domains → oma verkkotunnus → API ja luo verkkotunnusavain.
- Lähetä ensimmäinen viestisi yllä olevien esimerkkien avulla.