Pāriet uz dokumentāciju
API

Ātrais sākums

Atslēga un pirmais sūtījums.

1. Izveidojiet atslēgu

  1. Atveriet Settings → API keys. Šī lapa ir redzama tikai tad, ja pastkaste pieder jums.
  2. Nosauciet to pēc tā, kas to izmantos. Šis nosaukums ir veids, kā to atrast atpakaļ, kad kaut kas būs jāatsauc.
  3. Izvēlieties tās tvērumus. Pēc noklusējuma — tikai sūtīšana.
  4. Pēc izvēles sašauriniet, kā tā drīkst sūtīt: veseli domēni, atsevišķas adreses vai abi. Vesels domēns aptver arī vēlāk tam pievienotās adreses.
  5. Nokopējiet atslēgu. Tā tiek parādīta vienreiz un nav atgūstama: saglabāta tiek vienvirziena jaucējvērtība. Vēlāk rotējot atslēgu, aizstājēja tiek parādīta vienreiz tieši tāpat.

2. Nosūtiet kaut ko

npm install @openemail/sdk

Pēc izvēles. Katrs galapunkts ir vienkāršs HTTP un JSON, un zemāk esošajai curl cilnei nav vajadzīgs nekas instalēts.

curl -X POST https://api.openemail.uk/emails \  -H "Authorization: Bearer $OPENEMAIL_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "from": "Acme Billing <[email protected]>",    "to": ["[email protected]"],    "subject": "Your September invoice",    "html": "<p>Invoice attached.</p>"  }'

200 nozīmē, ka tas ir aizgājis. Jūs saņemat atpakaļ id. Paturiet to: tas ir veids, kā izgūt ziņojumu, izlasīt tā notikumu pēdas vai atcelt to, ja to ieplānojāt.

Saņemat 403, ko negaidījāt? GET /addresses uzskaita tieši to, kā šī atslēga drīkst sūtīt. Gandrīz vienmēr vaina ir atslēgas sūtīšanas tvērumā vai domēnā vai adresē, kas tai nav dota, nevis trūkstošā domēnā darbvietā.