API-d

Kui sulle meeldib minu loodud projekt(id) ja soovid seda oma kodulehele lisada, siis allpool on toodud mõned API-id koos juhendiga.

NB! Kui leiad viga mõne API töös, siis ootan selle kohta tagasidet koos täpse kirjeldusega (s.h. kasutatud täpne link jne), mis vea esile kutsuse-kirja teel.

Spikker:

  • Üldine struktuur: http://jyri78.eu/api/API-NIMI/param1:val1/param2:val2/param3:val3/... või ilma parameetri nimeta (NB! Siin on järjekord oluline): http://jyri78.eu/api/API-NIMI/val1/val2/val3/.... Lubatud on ka näit. alguses parameetri nimi ära jätta ja siis lõpus olev väärtus anda koos parameetri nimega: http://jyri78.eu/api/API-NIMI/val1/val2/param6:val6 (mitte vastupidi; vahele võib jätta mittekohustuslikud para­meetrid/väärtused).
  • Igale API-le on lisatud lihtne HTML-leht, kasutades parameetrina html: http://jyri78.eu/api/API-NIMI/html; samuti on parameetritena kehtivad ajax ja js.

  • Süntaksi osad:
    • ülevaatlikkuse eesmärgil on lingi algus http://jyri78.eu/api ära jäetud, see tuleb sul endal lisada (... asemel), ning parameetrite vahele lisatud tühikud (lingis siiski parem mitte kasutada);
    • / ja :  –  reserveeritud, s.t. parameetri väärtuses kasutada ei saa:
      • / kasut. parameetrite/väärtuste eraldamiseks ja
      • : kasut. parameetri nime ja väärtuse eraldajana;
    • [...]  –  nurksulgude vahel olev osa ei ole kohustuslik;Erisus: kui nurksulgude ümber on veel tavaline sulg – ([...]) –, siis ainult väärtuste esitamise korral võib selle vahele jätta (reeglina kohe kohustusliku parameetri/väärtuse järel);
    • {...}  –  parameetri nimi, vaikeväärtuse korral on võrdusmärgi = järel lisatud vaikeväärtus. Parameetri nimi võib esitada täisnimega, nagu süntaksis näidatud või ühetähelisena (kui võimalik), või liit- või mitmesõnalise nime korral sõnade esitähtede abil.

Biorütmid

Biorütmide diagrammi loomise API, mille tulemusel tagastatakse PNG-pilt.

Üldine süntaks (vt. eespool spikrit):

.../biorutmid/{synnipaev} ([/{kuupaev=now()}]) [/{laius=760}] [/{korgus=360}] [/{veerised=20,35,40}] [/{paevade-arv=30}] [/{keel=et}]
  • synnipaev või sp  –  sünnipäev kujul PP.KK.AAAA või PP.KK.AAAA,TT.MM, eraldajana võib kasutada ka -. Üldiselt kellaajal on väike mõju;
  • kuupaev või kp  –  kuupäev, mis seisuga diagrammi esitada. Kui sünnipäev on esitatud ilma kellaajata, siis eiratakse ka siin. Vaikimisi hetkel kehtiv kuupäev;
  • laius või l  –  pildi laius pikslites. Vaikimisi 760;
  • korgus või k  –  pildi kõrgus pikslites. Vaikimisi 360;
  • veerised või v  –  veerised pildil oleva diagrammi ümber (üleval, all ja külgedel) pikslites. Vaikimisi 20,35,40;
  • paevade-arv või pa  –  kui mitme päeva kohta diagramm tehakse (kuupäev jääb keskele). Vaikimisi 30;
  • keel või kl  –  diagrammi keele lühend, praegu toetatud ainult eesti et ja inglise en keel. Vaikimisi et.

Mõned näited kasutamise kohta:

http://jyri78.eu/api/biorutmid/29.03.1978/29.08.2016/640/300/25,40,50/20
http://jyri78.eu/api/biorutmid/29-03-1978,14-15/640/300/25,40,50/20/en
http://jyri78.eu/api/biorutmid/29.03.1978/korgus:400/pa:20

# Parameetri nime kasutamise korral järjekord ei ole oluline:
http://jyri78.eu/api/biorutmid/pa:20/sp:29.03.1978

Kasutamine:

Esmalt tuleb lisada HTML-kood järgmiselt:

<img id="pilt" src="" />

<form id="vorm" method="post" action="{link-sinu-lehele-voi-muud}">
  Palun sisesta oma sünnipäev:
  <input type="text" name="synnipaev" id="synnipaev" placeholder="PP.KK.AAAA" />
  <input type="submit" class="button" value=" OK " />
</form>

Järgmiseks tuleb päisesse lisada JavaScript (kasutan siinkohal jQuery teeki):

$(document).ready(function(){
  $('#vorm').submit(function(e){
    e.preventDefault();
    $('#pilt').attr('src','http://jyri78.eu/api/biorutmid/' + $('synnipaev').val());
  });
});

Alternatiivina võid kasutada minu loodud lihtsat HTML-lehte:

<iframe src="http://jyri78.eu/api/biorutmid/html" width="780" height="450" />

Copyright © 2009-2013, 2014-2016, 2018 Jüri Kormik. Kõik õigused kaitstud.