Búa til og hafa umsjón með API-lyklinum þínum

Published: 16. júlí 2026 · Last updated: 21. júlí 2026 · By Marcus Biel

API-lyklasíðan veitir utanaðkomandi kerfi auðkenndan aðgang að studdum Maildroppa API-endapunktum á reikningnum þínum.

Þú getur búið til einn API-lykil, afritað allt leynigildi hans, endurstillt hann á öruggan hátt með því að snúa honum, eða eytt honum þegar hans er ekki lengur þörf. Sama reikningslykil má nota í samþættingum á netþjóni og af API-beiðnikveikjum í Maildroppa Automations.

API-lykill táknar Maildroppa-reikninginn þinn. Farðu með hann eins og lykilorð: hver sem fær lykilinn getur kallað á þá API-endapunkta sem lykillinn hefur aðgang að þar til þú snýrð honum eða eyðir honum.

Til hvers API-lykillinn er

Notaðu API-lykilinn þegar hugbúnaður utan Maildroppa þarf að vinna með Maildroppa án gagnvirkrar innskráningar notanda.

Dæmigerð dæmi eru:

• Samstilling áskrifenda við CRM-kerfi, verslun, félagakerfi eða innri gagnagrunn.
• Að búa til eða uppfæra áskrifendur úr forriti á netþjóni.
• Lestur eða umsýsla með merkjum, reitum, reitagildum og hlutum í gegnum studda endapunkta.
• Sending sérsniðinna atburða á API-beiðnikveikju í Automation.
• Sending viðskiptapósta í gegnum API.
• Umsýsla með webhook-áskriftum sem byggja á API.

API-lykurinn er ætlaður fyrir samskipti milli netþjóna. Hann er ekki ætlaður fyrir kóða sem keyrir í vafra gesta, á opinberri vefsíðu, í farsímaforriti eða í innbyggðu skráningarformi.

Síðan er nú merkt „beta“. Notaðu tengdu OpenAPI-skjölin sem heimild fyrir þeim endapunktum, beiðnilikömum, færibreytum og svarskemu sem API-ið styður nú.

Opna API-lyklasíðuna

Opnaðu „Settings“, flettu út „Developers“ og veldu „API key“.

Þú getur einnig opnað síðuna beint á:

https://app.maildroppa.com/settings/developers/api-key

Síðan inniheldur:

• API-lyklaspjald með beta-merki.
• Tengilinn „View OpenAPI docs“.
• Tómt ástand og hnappinn „Create API key“ þegar enginn lykill er til.
• Dylktan framsetning á núverandi lykli þegar slíkur er til.
• Hnappinn „Copy“ sem afritar allan lykilinn.
• Aðgerðirnar „Rotate API key“ og „Delete API key“ til að skipta út eða fjarlægja núverandi lykil.

Maildroppa leyfir einn API-lykil á hvern reikning. Síðan býr ekki til aðskilda lykla fyrir einstök forrit, umhverfi eða liðsmenn.

Búa til API-lykil

Þegar síðan sýnir „No API key yet“ skaltu smella á „Create API key“.

Maildroppa býr lykilinn til samstundis. Enginn staðfestingargluggi birtist við þessa fyrstu stofnun. Á meðan beiðnin er í vinnslu breytist hnappurinn í „Creating API key“ og síðan slekkur tímabundið á frekari lykilaðgerðum.

Eftir að lykillinn hefur verið búinn til:

• Hið tóma ástand hverfur.
• Dylktan lykill birtist.
• Aðgerðirnar „Copy“, „Rotate API key“ og „Delete API key“ verða tiltækar.
• Maildroppa birtir árangursskilaboðin „API key updated“.

Ef annar lykill er þegar til fyrir reikninginn býr Maildroppa ekki til annan lykil. Notaðu lykilinn sem fyrir er eða snúðu honum.

Skilja dulda lykilinn

Síðan birtir ekki allt leynigildið sem venjulegan texta. Hún sýnir fyrstu fimm stafina og síðan fimm stjörnur, til dæmis:

a1b2c*****

Þetta er aðeins sjónræn dulin framsetning. Stjörnurnar tákna ekki raunverulega lengd lykilsins og dulda gildið er ekki hægt að nota í API-beiðni.

Smelltu á „Copy“ til að skrifa allan núverandi lykilinn á klippiborðið. Eftir að afritun tekst breytist hnappurinn tímabundið í „Copied!“.

Lykillinn helst duldur þegar þú kemur aftur á síðuna, en „Copy“ afritar áfram allt núverandi gildi. Þú þarft því ekki að snúa gildum lykli aðeins vegna þess að þú vistaðir hann ekki við stofnun.

Geyma lykilinn á öruggan hátt

Færðu afritaða lykilinn beint í leynigeymsluna sem samþættingin notar.

Hentugir staðir eru meðal annars:

• Stýrður leynistjóri.
• Vernduð umhverfisstilling netþjóns.
• Dulkóðað leyndarmál í uppsetningu.
• Lykilorðastjóri sem notaður er til að endurheimta rekstur.

Ekki geyma lykilinn í:

• JavaScript-kóða í vafra eða öðrum niðurhalanlegum framendapakka.
• Opinberri eða einkarekinni frumkóðaskrá sem er send inn í gagnageymslu.
• Vefslóð eða fyrirspurnarfæribreytu.
• Opinberum skjölum, skjámyndum, stuðningsskilaboðum eða verkbeiðnakerfum.
• Sameiginlegum forritaskrám, greiningaratburðum eða villuskýrslum.
• Ódulkóðuðu töflureiknisskjali eða venjulegu liðsspjalli.

Ekki bæta lyklinum við curl-dæmi sem verður afritað í skjöl eða sameiginlega skeljasögu. Kjósa skal umhverfisbreytu á borð við MAILDROPPA_API_KEY.

Nota API-lykilinn

Sendu allan lykilinn í X-API-Key HTTP-beiðnihausnum:

X-API-Key: your-complete-api-key

Ekki senda hann sem Bearer-tákn. Maildroppa væntir X-API-Key, ekki Authorization: Bearer ....

Framleiðslu-API-ið og gagnvirk OpenAPI-skjöl þess eru aðgengileg á:

https://api.maildroppa.com

Smelltu á „View OpenAPI docs“ á API-lyklasíðunni til að opna skjölin í nýjum vafraflipa. Veldu endapunkt þar til að skoða aðferð hans, slóð, færibreytur, meginmál beiðni, svartegund og mögulega stöðukóða.

Dæmi um beiðni

Eftirfarandi dæmi sækir fyrstu síðu áskrifenda. Það les lykilinn úr umhverfisbreytu í stað þess að setja leyndarmálið beint í skipunina:

curl --request GET \
  --url 'https://api.maildroppa.com/subscribers?pageNumber=1' \
  --header 'Accept: application/json' \
  --header "X-API-Key: ${MAILDROPPA_API_KEY}"

Stilltu breytuna í örugga umhverfinu þar sem samþættingin keyrir. Nákvæm aðferð, slóð, fyrirspurnarfæribreytur og meginmál ráðast af endapunktinum. Afritaðu þessar upplýsingar úr OpenAPI-skjölunum í stað þess að giska út frá aðgerðum sem eru tiltækar í Maildroppa-forritinu.

Beiðnir með JSON-meginmáli

Fyrir beiðni sem sendir JSON skaltu einnig láta fylgja:

Content-Type: application/json

Til dæmis er grunnbyggingin:

curl --request POST \
  --url 'https://api.maildroppa.com/example-endpoint' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-API-Key: ${MAILDROPPA_API_KEY}" \
  --data '{"example":"value"}'

/example-endpoint og meginmál þess eru staðgenglar. Skiptu þeim út fyrir skjalfestan endapunkt og skjalfest beiðniskema hans.

Hverju lykillinn hefur aðgang að

Lykillinn virkar aðeins með endapunktum sem styðja auðkenningu með API-lykli. Síða eða beiðni sem Maildroppa-forritið notar innbyrðis er ekki sjálfkrafa hluti af opinberu API-i viðskiptavina.

OpenAPI-skjölin sýna studda API-ið fyrir viðskiptavini. Ef slóð er ekki skjalfest til notkunar með API-lykli skaltu ekki gera ráð fyrir að lykillinn hafi aðgang að henni.

API-lyklasíðan býður ekki upp á umfang eða gátreiti fyrir heimildir eftir endapunktum. Því þarf að meðhöndla núverandi reikningslykil sem verðmæt skilríki, jafnvel þótt ein samþætting noti aðeins einn endapunkt.

Hraðatakmarkanir

Núverandi OpenAPI-samningur skjalfestir eftirfarandi takmarkanir fyrir API-lykla:

• Sjálfgefið API viðskiptavina: 300 beiðnir á mínútu og 2.000 beiðnir á klukkustund.
• Events API á /events: 100 beiðnir á sekúndu með sprengigetu upp á 500 beiðnir.

Þessar takmarkanir gilda um Maildroppa-reikninginn, ekki sjálfstætt um hvert skrift sem deilir lyklinum. Margar samþættingar geta því notað sama kvóta.

Þegar Maildroppa skilar 429 Too Many Requests skaltu hætta að senda nýjar beiðnir og virða Retry-After svarhausinn þegar hann er til staðar. Notaðu biðröð og stýrða bakfærslu í stað þess að hefja margar samhliða endurtekningar.

Hraðatakmarkanir geta breyst á meðan API-ið er í beta. Skoðaðu upplýsingarnar efst í OpenAPI-skjölunum áður en þú hannar samþættingar með miklu umfangi.

Nota lykilinn fyrir API-beiðnir í Automation

Automation getur hafist þegar kerfið þitt sendir sérsniðinn atburð í Events API Maildroppa.

Þegar þú stillir „API request“-kveikju notar Maildroppa sama API-lykil reikningsins og er stjórnað á þessari síðu. Uppsetning kveikjunnar getur búið lykilinn til þegar enginn er til og afritað tilbúna curl-beiðni sem inniheldur allan lykilinn.

Þetta hefur tvær mikilvægar afleiðingar:

• Að snúa eða eyða reikningslyklinum hefur einnig áhrif á kerfi sem senda sérsniðna atburði í Automations.
• Afritað Automation-beiðnidæmi inniheldur leyndarmálið á klippiborðinu þó lykillinn sé dulinn á skjánum.

Áður en þú snýrð eða eyðir lyklinum skaltu skrá allar API-beiðnikveikjur og alla utanaðkomandi atburðasenda í samþættingaskránni þinni.

Endurstilla eða skipta út API-lyklinum

Notaðu „Rotate API key“ þegar þú þarft að endurstilla eða skipta út núverandi skilríki. Maildroppa býr til nýjan lykil og ógildir fyrri lykilinn sem hluta af sömu aðgerð.

Notaðu snúning þegar:

• Lykillinn gæti hafa komist í hendur óviðkomandi.
• Einstaklingur eða þjónustuaðili sem þekkti lykilinn þarf ekki lengur aðgang.
• Öryggisstefna þín krefst reglulegrar endurnýjunar skilríkja.
• Þú vilt skipta út lykli sem er geymdur á gömlum eða óöruggum stað.

Smelltu á „Rotate API key“ fyrir neðan dulda lykilinn. Maildroppa opnar viðvörunarglugga sem útskýrir að ekki verði lengur hægt að nota núverandi lykil.

Smelltu á „Rotate API key“ í glugganum til að halda áfram eða á „Cancel“ til að halda núverandi lykli.

Snúningur hefur engan biðtíma

Eftir að þú staðfestir snúning hættir gamli lykillinn að virka samstundis. Maildroppa heldur ekki bæði gamla og nýja lyklinum gildum á sama tíma.

Þar sem reikningurinn hefur aðeins einn lykil hefur snúningur áhrif á alla netþjóna, áætluð verk, samþættingar, skriftur og Automation-atburðasenda sem nota hann.

Notaðu þessa röð við fyrirhugaðan snúning:

1. Skráðu allar samþættingar sem nota núverandi lykil.
2. Tryggðu aðgang að leynistillingum og uppsetningarferli hverrar samþættingar.
3. Veldu stutt viðhaldsvindut ef samfelldur API-aðgangur er mikilvægur.
4. Smelltu á „Rotate API key“ og staðfestu síðan viðvörunina með „Rotate API key“ í glugganum.
5. Smelltu á „Copy“ til að afrita allan nýja lykilinn.
6. Skiptu strax út leyndarmálinu í öllum samþættingum.
7. Endurræstu eða settu aftur upp þjónustur sem lesa leyndarmál aðeins við ræsingu.
8. Sendu meinlausa skjalfesta beiðni til að sannreyna hverja samþættingu.
9. Leitaðu að 401 Unauthorized svörum frá gleymdri þjónustu sem notar enn gamla lykilinn.

Ef talið er að núverandi lykill hafi komist í hendur óviðkomandi skaltu snúa honum strax og sætta þig við þá stuttu truflun sem þarf til að uppfæra lögmæt kerfi.

Eyða API-lyklinum

Eyddu lyklinum þegar reikningurinn á ekki lengur að taka við beiðnum sem auðkenndar eru með API-lykli.

Smelltu á „Delete API key“ fyrir neðan dulda lykilinn. Maildroppa opnar viðvörunarglugga sem útskýrir að lyklinum verði eytt varanlega af reikningnum.

Smelltu á „Delete API key“ í glugganum til að eyða honum eða á „Cancel“ til að halda honum.

Eftir eyðingu:

• Núverandi lykill hættir að virka samstundis.
• Síðan fer aftur í ástandið „No API key yet“.
• Samþættingar á netþjónum sem nota eydda lykilinn geta ekki lengur auðkennt sig.
• Sendendur Automation API-beiðna sem nota lykilinn geta ekki lengur sent atburði.

Eyðing lykils eyðir ekki áskrifendum, herferðum, merkjum, reitum, hlutum, Automations eða öðrum reikningsgögnum. Hún fjarlægir skilríkið sem notað er til að fá aðgang að studdum API-endapunktum.

Þú getur síðar smellt á „Create API key“ til að búa til ný skilríki. Eydda gildið er ekki endurheimt. Uppfæra þarf allar samþættingar áður en þær geta notað nýja lykilinn.

Endurstilla eða eyða: Hvort ættir þú að velja?

Veldu „Rotate API key“ þegar API-aðgangur á að halda áfram með nýjum skilríkjum.

Veldu eyðingu þegar API-aðgangur á að stöðvast alveg, að minnsta kosti tímabundið.

Báðar aðgerðir ógilda núverandi lykil samstundis. Snúningur býr til staðgengilinn í sömu aðgerð; eyðing skilur reikninginn eftir án lykils.

Öryggisráðleggingar

Haltu API-köllum á netþjóninum þínum

Vafri eða farsímaforrit getur ekki haldið innbyggðu leyndarmáli áreiðanlega. Notandi getur skoðað forritið, beiðnihausa, frumkóðakort eða netumferð og náð í lykilinn.

Ef vefsíða eða forrit þarf að kalla fram aðgerð skaltu fyrst senda beiðnina á þinn eigin auðkennda bakenda. Láttu bakendann sannprófa notandann og kalla á Maildroppa með lykilnum sem geymdur er á netþjóninum.

Lágmarkaðu útsetningu

Gefðu lyklinum aðeins kerfum sem þurfa hann. Ekki dreifa honum til allra þróunaraðila eða líma hann inn í margar staðbundnar stillingaskrár.

Þar sem síðan stýrir nú einum lykli fyrir allan reikninginn í stað margra nafngreindra eða afmarkaðra lykla skaltu nota innri samþættingarþjónustu eða millilag ef mörg forrit þurfa sterkari einangrun hvert frá öðru.

Feldu beiðnihausa

Stilltu HTTP-viðskiptavini, öfuga milliþjóna, sýnileikatól og villuskýrslutól þannig að þau feli X-API-Key. Beiðni getur virkað rétt en samt lekið skilríkjunum í villuleitarskráningu.

Haltu umhverfum aðskildum

Ekki endurnota framleiðslulykil í staðbundinni þróun, sýniskóða, skjámyndum eða prófunargögnum. Geymdu leyndarmál fyrir hvert umhverfi í leynigeymslu þess umhverfis.

Tengillinn „View OpenAPI docs“ vísar sjálfkrafa framleiðslunotendum á OpenAPI-skjöl framleiðslu. Athugaðu alltaf hýsingarheitið áður en þú sendir raunverulegan lykil.

Snúðu lyklinum eftir grun um útsetningu

Eyðing skilaboða, færslu í gagnageymslu, línu í annál eða skjámyndar sannar ekki að enginn hafi afritað lykilinn. Ef allt gildið var útsett skaltu snúa lyklinum.

Meðhöndla API-villur

Notaðu HTTP-stöðuna og skjalfest svarmál til að ákveða hvað samþættingin á að gera.

Algeng tilvik eru:

• 400 Bad Request — Slóðin, færibreytan eða JSON-meginmálið uppfyllir ekki samning endapunktsins. Berðu beiðnina saman við OpenAPI-skemuna.
• 401 Unauthorized — X-API-Key-hausinn vantar, er auður, ógildur, eyddur eða inniheldur gamalt gildi eftir snúning.
• 403 Forbidden — Auðkenndi lykillinn hefur ekki heimild til að nota aðgerðina.
• 404 Not Found — Slóðin eða tilgreint tilföng er ekki til á þessum reikningi.
• 429 Too Many Requests — Samþættingin hefur náð hraðatakmörkun API-sins. Gerðu hlé á beiðnum og virtu Retry-After-hausinn þegar hann er til staðar.
• 5xx — Maildroppa gat ekki lokið beiðninni. Endurtaktu öruggar aðgerðir með takmarkaðri veldisvísis-bakfærslu og skráningu sem útilokar API-lykilinn.

Ekki endurtaka allar villur í blindni. Leiðréttu 400, 401, 403 og flestar 404-svör áður en sama beiðni er send aftur.

Fyrir beiðnir sem breyta gögnum skaltu staðfesta endurtekningar- og auðkenningarhegðun endapunktsins áður en þú endurtekur beiðni sjálfkrafa. Tengingarbilun sannar ekki alltaf að Maildroppa hafi ekki gert breytingu.

Úrræðaleit

„Create API key“ er enn sýnt

Enginn lykill er nú til á reikningnum. Smelltu einu sinni á hnappinn og bíddu eftir að beiðninni ljúki.

Ef stofnun mistekst skaltu endurhlaða síðuna áður en þú reynir aftur. Önnur síða eða Automation-uppsetning gæti þegar hafa búið til reikningslykilinn.

Lykillinn á síðunni virðist of stuttur

Síðan sýnir viljandi aðeins fyrstu fimm stafina og *****. Smelltu á „Copy“ til að afrita allt gildið. Ekki senda dulda textann í beiðni.

„Copy“ breytist ekki í „Copied!“

Vafrinn gæti hafa lokað fyrir aðgang að klippiborðinu. Hafðu síðuna í virka flipanum, leyfðu aðgang að klippiborðinu ef beðið er um það og smelltu aftur á „Copy“.

Ekki reyna að endurgera lykilinn út frá dulda textanum.

Beiðni skilar 401 Unauthorized

Athugaðu að:

• Heiti haussins sé nákvæmlega X-API-Key.
• Hausinn innihaldi allt gildið án sýnilegu stjarnanna.
• Samþættingin sendi ekki Authorization: Bearer í staðinn.
• Bili, gæsalöppum eða nýlínu hafi ekki verið bætt við leyndarmálið.
• Enginn hafi snúið eða eytt reikningslyklinum.
• Þjónusta hafi verið endurræst ef hún les umhverfisbreytur aðeins við ræsingu.
• Beiðnin sé send í rétt Maildroppa API-umhverfi.

Ein samþætting virkar en önnur hætti eftir snúning

Seinni samþættingin notar líklega enn gamla lykilinn. Enginn skörunartími er til staðar. Uppfærðu leyndarmál hennar og endurræstu öll ferli sem vista stillingar í skyndiminni.

OpenAPI-síðan virkar en endapunktur skilar 403

Ekki styðja allir endapunktar forritsins auðkenningu með API-lykli. Notaðu aðgerð sem er skjalfest fyrir API viðskiptavina og staðfestu auðkenningarkröfur hennar á OpenAPI-síðunni.

Beiðnir skila 429 Too Many Requests

Dragðu úr beiðnahrinum, settu vinnu í biðröð og reyndu aftur eftir þeim biðtíma sem API-ið skilar. Forðastu samhliða endurtekningarhrinur. Ef mörg forrit deila einum reikningslykli skaltu samræma beiðnamagn þeirra því þau deila API-takmörkum reikningsins.

Gátlisti fyrir ráðlagða uppsetningu

Áður en þú setur samþættingu í reglulega notkun skaltu staðfesta að:

• Lykillinn sé aðeins geymdur í leynistillingum á netþjóni.
• Beiðnir noti X-API-Key-hausinn.
• Samþættingin noti https://api.maildroppa.com í framleiðslu.
• Allar aðferðir, slóðir, færibreytur og JSON-meginmál fylgi OpenAPI-skjölunum.
• Annálar og villuskýrslur feli lykilinn.
• Tímamörk og takmarkaðar endurtekningar séu stillt.
• Fylgst sé með 401, 403, 429 og villum á netþjóni.
• Eigandi samþættingarinnar sé skráður.
• Öll kerfi sem deila reikningslyklinum séu með í snúningsáætluninni.
• Hægt sé að snúa viðkomandi lykli hratt ef hann kemst í hendur óviðkomandi.

API-lyklasíðan er viljandi lítil, en aðgerðir hennar hafa áhrif á allar API-samþættingar sem tengjast reikningnum. Búðu aðeins til lykilinn þegar hans er þörf, geymdu hann á traustum netþjónum og skipuleggðu snúning sem breytingu á skilríki fyrir allan reikninginn.