API dokumentácia

• Štruktúra volania
• Štruktúra odpovede
• Generovanie podpisu
• Chybová odpoveď servra

• addIncome
• addCustomer
• editCustomer

Volanie API prebieha vždy na URL https://evidujem.sk/api/.

Štruktúra volania

Štruktúra odpovede

Odpoveď servra je vždy vo formáte JSON a je špecifická podľa typu požiadavku. Chybová odpoveď je definovaná nižšie

Generovanie podpisu

Podpis slúži na overenie odosielateľa zasielaných dát. Overenie prebieha pomocou kľúča (KEY), ktorý si môžete vygenerovať v nastaveniach aplikácie.

Samotný výpočet podpisu prebieha pomocou nasledujúceho kódu v PHP:

Podpis generovaný týmto spôsobom je vyžadovaný vždy pri odosielaní požiadavku, kde METHOD a DATA predstavujú obsah príslušných parametrov požiadavku.
Pokiaľ už máte DATA serializované, metóda serialize sa na nich nevolá.

Metódy a ich dáta

> addIncome <

Požiadavok slúži na pridanie príjmu s možnosťou generovania faktúry.

Štruktúra parametru DATA v požiadavku klienta

array(){
  'title' => 'Názov položky', //v prípade nastavenia 'invoice' je ignorovaný a generuje sa číslo faktúry
  'description' => 'Popis',
  'customer' => 'Hraško s.r.o.',
  'addDate' => '1.1.2015', //dátum pridania
  'dueDate' => '20.1.2015', //dátum splatnosti
  'payedDate' => '10.1.2015', //dátum zaplatenia, v prípade nezaplatenia NULL
  'price' => 101.50,
  'vat' => 0,  //v prípade platcov DPH konkrétna hodnota
  'taxable' => true,

  'invoice' => array( //v prípade generovania faktúry sa zahrnú i tieto dáta
    'generateLink' => false //v prípade true vráti URL adresu pre stiahnutie faktúry

    'payType' => 0, //spôsob platby - hodnota podľa zoznamu nižšie
    'payConst' => '0308', //konštantný symbol
    'paySpec' => '', //špecifický symbol
    'topNote' => '', //poznámka nad čiarou
    'issuedBy' => 'Ing. Janko Mrknička', //kto inzerát vystavuje
    'phone' => '0900123456', //telefón na vystavovateľa faktúry
    'email' => 'janko.mrkvicka@mojbiznis.sk', //email na vystavovateľa faktúry
    'deliveryType' => 0, //spôsob dodania - hodnota podľa zoznamu nižšie
    'deliveryDate' => '20.1.2015', //dátum dodania
    'note' => 'Nie sme platcami DPH', //poznámka

    'items' => array( //zoznam položiek
      array(
        'title' => 'Názov položky',
        'amount' => 2, //množstvo
        'unit' => 'ks.', //jednotka    
        'price' => 10.5, //cena za kus      
        'subtotal' => 21, //celková cena
        'note' => '', //poznámka
      ),
      array(
        //ďalší prvok..
      ),
    ),
  ),
}

Číselníky hodnôt

Štruktúra odpovede servra

{
  "title" : "Názov vytvoreného záznamu alebo faktúry",
  "url" : "Názov položky", //len v prípade zadania 'invoice' a hodnoty 'generateLink' nastavenej na true
}

> addCustomer <

Pridanie zákazníka či dodávateľa. Mimo company sú položky nepovinné.

Štruktúra parametru DATA v požiadavku klienta

array(){
  'company' => 'Meno osoby alebo názov firmy',
  'ico' => '012345678', //IČO
  'dic' => '12345678910', //DIČ
  'idic' => 'SK 12345678910', //IČ DPH
  'description' => 'Popis k zákazníkovi / dodávateľovi',
  'address' => 'Adresa kontaktu',
  'zip' => '01234', //PSČ
  'city' => 'Mesto',
  'country' => 'Štát',      
  'person' => 'Kontaktná osoba',
  'phone' => 'Telefón',
  'email' => 'Email@email.mail',  
}

Štruktúra odpovede servra

{
  "state" : "OK",
}

> editCustomer <

Aktualizácia zákazníka či dodávateľa. Mimo company sú položky nepovinné.
Štruktúra parametru DATA je zhodná so štruktúrov pri volaní metódy addCustomer.

Štruktúra odpovede servra v prípade chyby

{
  "error" : "Popis chyby",
}