Osnovni pojmi

Tukaj so na voljo navodila za uporabo aplikacije SqualoMail za razvijalce aplikacij, torej dokumentacija API vmesnika.

Za pravilno razumevanje navodil bomo najprej definirali nekaj osnovnih pojmov:

  • Aplikacija
    Vsaka naša stranka ima lahko eno ali več aplikacij. Ločijo se po tem, da je vsaka dostopna na svojem URL naslovu.
    Primer: https://app_id.squalomail.net
  • app_id
    To je ID številka aplikacije. Najdete jo lahko v grafičnem uporabniškem vmesniku, ali pa kar iz URL naslova, ko ste prijavljeni v svojo SqualoMail aplikacijo. Format ID-ja je štirimestna številka.
    Primer: https://2221.squalomail.net.
    Četudi uporabljate prilagojeno domeno, vedno obstaja app_id, ki ni nikoli enak vaši prilagojeni domeni.
  • Uporabniški API
    Tukaj so funkcionalnosti, do katerih lahko odjemalci dostopajo neposredno. Na primer: Prijavni obrazec na vaši spletni strani, ki ga dejansko “POST-a” obiskovalec vaše spletne strani in tako neposredno dostopa do sistema SqualoMail.
  • Sistemski API
    Aplikacijski programski vmesnik, ki je namenjen neposredni komunikaciji med vašimi aplikacijami in aplikacijo SqualoMail. Ta vmesnik ni primeren za odjemalce (vaš client side) ampak za strežnike (vaš server side). Če bi to namreč uporabljali na client side-u, bi ogrozili vaše podatke.

Dokumentacija je tako tukaj razdeljena na 2 dela:

  1. UPORABNIŠKI API
  2. SISTEMSKI API