API pro zjišťování kreditu

Součást Odorik.cz API určená pro práci s kreditem.

• vrací aktuální kredit uživatele v Kč zaokrouhlený na dvě desetinná místa
• formát odpovědi: plain-text
• vyžaduje autentizaci
• příklad odpovědi:

  193.32

• vrací aktuální kredit uživatele v Kč zaokrouhlený na dvě desetinná místa
• formát odpovědi: XML
• vyžaduje autentizaci
• nepovinné parametry:
  • format: nastavením na hodnotu acrobits bude vráceno XML pro klienta Acrobits Softphone - viz fórum http://forum.odorik.cz/viewtopic.php?f=19&t=2547&p=36587#p36587

• umožňuje převod kreditu jinému uživateli Odorik.cz
• formát odpovědi: JSON
• vyžaduje autentizaci
• povinné parametry:
  • recipient: účet, na který se kredit převádí; PIN bez posledních 4 číslic (bývá to tedy buď mobilní číslo, na které je účet registrován, anebo číslo linky daného uživatele)
  • amount: částka určená k převedení; minimálně 50 Kč, na účtu odesílatele musí zůstat alespoň 10 Kč
• možné chybové stavy:
  • low_amount: musí být převáděno minimálně 10 Kč
  • low_balance: uživatelský účet odesílatele musí mít minimálně kredit 50 Kč
  • not_paid_yet: posílat kredit je možné až po prvním dobití
  • invalid_amount: neplatná částka, například vyšší než současný stav kreditu
  • low_leftover: na účtu odesílatele musí zůstat alespoň 10 Kč
  • nonexisting_user: účet příjemce se nepodařilo nalézt
  • same_account: snaha o převod kreditu v rámci jednoho účtu
• příklad odpovědi pro proběhnuvší převod:

{ "balance": 123.0 }

• příklad odpovědi při chybě (např. recipient=pepazdepa):

{ "errors": ["nonexisting_user"] }