Odorik.cz API

Pro přístup ke službám Odorik.cz z aplikací třetích stran poskytujeme API na adrese https://www.odorik.cz/api/v1/. Parametry jsou předávány standardně pomocí URI-encoding (respektive form-encoding na základě použité HTTP metody). Na většinu požadavků se snažíme odpovídat HTTP stavovým kódem 200 OK.

Autentizace

Většina operací vyžaduje autentizaci uživatele. Ta se provádí zasláním přihlašovacích údajů společně s požadavkem. Jedná se o proměnné user a password, přičemž existují dvě možnosti pro přihlášení:

  • Přihlášení platné pro celý účet
  • Přihlášení platné pro konkrétní linku
    • user - číslo linky v síti Odorik.cz
    • password - heslo pro danou linku (používané například i pro SIP autentizaci)
    • Seznam vašich linek můžete nalézt na http://www.odorik.cz/ucet/linky.html, hesla poté po kliknutí na jednotlivé linky.

Operace vyžadující autentizaci mohou vracet následující odpovědi:

  • error authentication_required
  • error authentication_failed

Identifikace klienta

Při použití API k implementaci některé z funkcí Odorik.cz do aplikací třetích stran (jako například Esmska nebo DreamCom) používejte prosím u požadavků nepovinný parametr user_agent.

Jednotlivé části části Odorik API

Ukázky použití a existující aplikace

Několik ukázek kódu je k dispozici na stránce Ukázky použití Odorik API.

Rozcestník aplikací používající naše API naleznete na stránce Aplikace využivající Odorik API.

Rozšiřitelnost

Pokud byste rádi přistupovali k některé ze služeb Odorik.cz pomocí API, kontaktujte nás prosím na karasODDELEJTOHLE@odorik.cz.

 
api.txt · Poslední úprava: 2017/09/21 09:48 autor: michal