SDK për Python
Klienti zyrtar Python për OpenEmail API. Sinkron dhe asinkron, i tipizuar tërësisht, dhe një metodë për çdo endpoint.
Çfarë është
Një paketë mbi gjithë API-në (dërgimi, shabllonet, gjurmimi, bisedat, draftet, etiketat, kontaktet, audiencat, formularët e regjistrimit, transmetimet, domenet, rregullat, webhook-et, kalendari, cilësimet, rolet, anëtarët, bllokimet, skedarët dhe kutitë e përkohshme) me një TypedDict për çdo kërkesë dhe përgjigje, dy klasa gabimesh, riprovime që nuk mund ta dyfishojnë një dërgim dhe një verifikues nënshkrimesh webhook-u. Funksionon në Python 3.10 e më të ri dhe varet vetëm nga httpx, anyio dhe typing-extensions. Mban një çelës API të hapësirës së punës ose një token qasjeje OAuth, ndaj vendi i saj është në një server ose në një mjet që funksionon në makinën tuaj, dhe kutitë e përkohshme janë e vetmja pjesë që nuk kërkon kredencial.
pip install openemailimport os from openemail import init, openemail init(os.environ['OPENEMAIL_API_KEY']) openemail.emails.send({ 'from': 'Acme Billing <[email protected]>', 'to': '[email protected]', 'subject': 'Your September invoice', 'html': '<p>Invoice attached.</p>',})Sinkron dhe asinkron
OpenEmail është sinkron, dhe AsyncOpenEmail është binjaku i tij asinkron me të njëjtat opsione dhe të njëjtat metoda, secila e thirrur me await. Funksionon në asyncio dhe trio, dhe një iterate me faqe bëhet një async for.
import asyncio from openemail import AsyncOpenEmail async def main() -> None: async with AsyncOpenEmail() as client: email = await client.emails.send({ 'from': 'Acme Billing <[email protected]>', 'to': '[email protected]', 'subject': 'Your September invoice', 'html': '<p>Invoice attached.</p>', }) async for thread in client.threads.iterate(folder='inbox'): print(thread['id']) print(email['id'], email['status']) asyncio.run(main())Klienti i përbashkët openemail është sinkron, ndaj ndërtojeni vetë një AsyncOpenEmail, një herë, dhe mbylleni me aclose() ose me një bllok async with.
Ku të shkoni
Mbështjell të njëjtën API si çdo klient tjetër
Gjithçka këtu është e njëjta sipërfaqe që dokumenton referenca e API-t, prandaj lexoni atë për çfarë bën një endpoint dhe këtë për si ta thirrni. Ka një metodë për çdo veprim të dokumentuar, dhe kontrolli i barazisë i paketës lexon dokumentin OpenAPI për ta vërtetuar.
Çdo metodë TypeScript ka një binjak në Python me të njëjtin emër në snake_case, dhe kontrolli i përputhshmërisë e ekzekuton çdo çift me të njëjtat argumente dhe dështon nëse ata nuk dërgojnë të njëjtën kërkesë, nuk riprovojnë në të njëjtën mënyrë ose nuk kthejnë të njëjtën vlerë.