Väga lihtsustatult on API-t vaja selle jaoks, et kahe erineva süsteemi vahel andmeid jagada. Ehk siis API on sisuliselt sild kahe süsteemi vahel, näiteks e-poe ja raamatupidamistarkvara vahel. Antud juhul oleks näiteks vaja, et e-poest liiguksid tellimused raamatupidamistarkvarasse, kus koostatakse arve ning uue laoseisu info saadetakse e-poodi.
Laiema mõistena kasutatakse API “silda” igapäevaselt meie ümber erinevate andmete vahetamiseks (bussiajad, telefoni äpid, sularahaautomaadid jne). API tähendab inglise keeles Application Program Interface ehk eesti keeles rakendusliides või programmiliides. Kahe süsteemi vahel suhtlemiseks on vaja eraldi võtit (parooli), tänu millele tehakse andmete jagamiseks “uks lahti”.
Kuidas SimplBooks tarkvaras API toimib?
Kui sinu kontol on API lubatud, siis API võtme saad kätte, kui lood kasutajate alt uue API kasutaja.
Sisuliselt on liidestuste kasutamiseks kaks varianti: 1) SimplBooks sisesed liidestused (API ei ole vajalik) ning 2) SimplBooks-ist välja jäävad liidestused (API on vajalik). Nagu öeldud, siis SimplBooks sisemisi liidestusi saab kasutada ilma API-ta ning nendeks on näiteks e-poed (WordPress WooCommerce, Prestashop, Shopify), e-arvete operaatorid (Envoice, Telema, FinBite(Omniva)), pangad (LHV, SEB, Swedbank), EMTA (KMD esitamiseks) ning kuludokumentide (tšekkide) halduseks CostPocket.
SimplBooks-is välja jäävate liidestuste jaoks on vaja API-t kasutada. API võimalust saab kasutada ainult Premium paketis. Välised liidestused on näiteks mõni WordPressi plugin või personaalselt loodud liidestus, mis asub SimplBooks tarkvarast väljas. WordPress-i (WooCommerce) jaoks pakub valmis välist liidestust näites E-liides.ee või YesItWorks. Mõlemal juhul on tegu kolmandast osapoolest teenusepakkujaga, kelle käest on vaja vastav liides osta ning SimplBooks ei vastuta liidestuse ja selle toimimise eest. Kui soovite personaalset liidestust mõne teise e-poe või programmiga, siis tuleb see liidestus ise luua või tellida. SimplBooks personaalse välise liidestuse loomiseks ise teenust ei paku.
SimplBooks API dokumentatsiooni (arendajatele) leiab siit – https://app.simplbooks.com/api-documentation/
See praegune sissejuhatav juhend ning api dokumentatsioon on kasutu. Sellist “Get Started” juhendit võiks olla ja korralikult välja kirjutatult et iga algaja saaks aru, kuidas api-dokumentatsioonis toodud päringuid praktikas kasutada.
Tere, Ivo!
Tänud tagasiside eest. Nö “Get Started” juhendi leiab API dokumentatsiooni lehelt vasakult menüüst esimese 5 punkti alt (Overview, Authentication, Requests, Responses, Error handling). Näited on toodud CURL päringutena. Nö näidis koodijuppe tõesti ei ole erinevate keelte kohta.