Základní informace

    API Služby VideoDoktor.cz

        https://[API_app_url].videodoktor.cz

API slouží pro ovládání uživatelských účtů lékařů vzdáleně, pro schávlenou implementaci do ambulantních nebo jiných softwarových řešení pro zdravotnictví.

Pokud chcete používat naše API kontaktujte nás na emailu podpora@videodoktor.cz, pokud schválíme Vaší implemetaci přidělíme Vám API app key a API app url i zkušební uživatelský účet. API pro každou implementaci je oddělené a proto jsme schopni do určité míry přizpůsobit API Vašim potřebám.

Požadavky musí být odesílány metodou POST. Odpovědi API jsou ve formátu JSON a znakové sadě UTF-8. Každému volání musí předcházet žádost o token. Nepoužitý token zaniká za 10-15 minut.

Získání tokenu


# Příklad volání pro získání tokenu
POST https://[API_app_url].videodoktor.cz/api_verify/
    'api_key=[api klíč ordinace]'
    'api_app_key=[přidělený api klíč implementace]'

Pro každé volání je potřeba nejprve získat token.
Pro získání tokenu se volá adresa:
https://[API_app_url].videodoktor.cz/api_verify/ 



Příklad odpovědi:

    {
        "token":"tokenABCDEFxyz0123456789"
    }

Parametry dotazu

Pole Typ Popis
api_key String API klíč registrované ordinace.
api_app_key String Váš přidělený API klíč aplikace/implemetace.

Vytvoření video hovoru / pozvánky


# Příklad volání pro vytvoření video hovoru / pozvánky
POST https://[API_app_url].videodoktor.cz/api_meet_add/
    'token=[získaný token]'
    'pacient_jmeno=[jméno pacienta]'
    'pacient_email=[email pacienta]'
    'pacient_telefon=[telefon pacienta]'
    'pacient_narozen=[rok narození pacienta]'
    'meet_start=[datum a čas hovoru]'

Při vytvoření video hovoru bude odeslána pozvánka pacientovi a potvrzení ordinaci (emailem).
Volá se adresa:
https://[API_app_url].videodoktor.cz/api_meet_add/ 



Příklad odpovědi:

    {
        "meet_id":"xxxxxxxxxxxxxxxxxx",
        "meet_url":"https:xxxxxxxxxxxxxxx"
    }

Parametry dotazu

Pole Typ Popis
token String Získaný token.
pacient_jmeno String Jméno pacienta (min. 6, max 64 znaků).
pacient_email String Email pacienta (min. 6, max 256 znaků).
pacient_telefon Integer Mobilní telefonní číslo pacienta (min. 9, max 9 znaků).
pacient_narozen Integer Rok narození pacienta (min. 4, max 4 znaků).
meet_start String Datum a čas hovoru v rozsahu a formátu.

Seznam video hovorů


# Příklad volání pro seznam video hovorů
POST https://[API_app_url].videodoktor.cz/api_meet_list/
    'token=[získaný token]'

Volá se adresa:
https://[API_app_url].videodoktor.cz/api_meet_list/ 



Příklad odpovědi:

[
    {
      "meet_id":"xxxxx",
      "meet_url":"httpsxxxxxxxxx",
      "meet_time":"23.11.2020 10:00",
      "meet_time_imd":"2020-11-23 10:00:00",
      "meet_active":0,
      "pacient_jmeno":"Jméno",
      "pacient_email":"email@gmail.com",
      "pacient_telefon":"000000000",
      "pacient_narozen":"0000"
    },{
      "meet_id":"xxxxx",
      "meet_url":"httpsxxxxxxxxx",
      "meet_time":"23.11.2020 10:00",
      "meet_time_imd":"2020-11-23 10:00:00",
      "meet_active":0,
      "pacient_jmeno":"Jméno",
      "pacient_email":"email@gmail.com",
      "pacient_telefon":"000000000",
      "pacient_narozen":"0000"
    }
]

Parametry dotazu

Pole Typ Popis
token String Získaný token.

Detail video hovoru


# Příklad volání pro detail video hovoru
POST https://[API_app_url].videodoktor.cz/api_meet_detail/
    'token=[získaný token]'
    'meet_id=[id požadovaného hovoru]'

Volá se adresa:
https://[API_app_url].videodoktor.cz/api_meet_detail/ 



Příklad odpovědi:

    {
      "meet_id":"xxxxx",
      "meet_url":"httpsxxxxxxxxx",
      "meet_time":"23.11.2020 10:00",
      "meet_time_imd":"2020-11-23 10:00:00",
      "meet_active":0,
      "pacient_jmeno":"Jméno",
      "pacient_email":"email@gmail.com",
      "pacient_telefon":"000000000",
      "pacient_narozen":"0000"
    }

Parametry dotazu

Pole Typ Popis
token String Získaný token.
meet_id String Identifikátor hovoru (získaný při vytváření nebo ze seznamu)

Odstranění video hovoru


# Příklad volání pro odstranění video hovoru
POST https://[API_app_url].videodoktor.cz/api_meet_remove/
    'token=[získaný token]'
    'meet_id=[id požadovaného hovoru]'

Při odstranění video hovoru bude vyrozuměn pacient i ordinace (emailem)
Volá se adresa:
https://[API_app_url].videodoktor.cz/api_meet_remove/ 



Příklad odpovědi:

    {
        "meet_id":"xxxxxxxxxxxxxxx"
    }

Parametry dotazu

Pole Typ Popis
token String Získaný token.
meet_id String Identifikátor hovoru (získaný při vytváření nebo ze seznamu)

Výkaz video hovoru


# Příklad volání pro získání url výkazu video hovoru
POST https://[API_app_url].videodoktor.cz/api_meet_export/
    'token=[získaný token]'
    'meet_id=[id požadovaného hovoru]'

Výkaz je dostupný následující den po termínu hovoru.
Volá se adresa:
https://[API_app_url].videodoktor.cz/api_meet_export/ 



Příklad odpovědi:

    {
        "export_url":"httpsxxxxxxxxx"
    }

Parametry dotazu

Pole Typ Popis
token String Získaný token.
meet_id String Identifikátor hovoru (získaný při vytváření nebo ze seznamu)

Datum a čas


# Aktuální datum a čas ve správném formátu
https://[API_app_url].videodoktor.cz/api_time/

Adresa pro zjištění aktuálního času na serveru:
https://[API_app_url].videodoktor.cz/api_time/ 



Příklad odpovědi:

    {
        "time":"21.11.2020.01.18"
    }

Chyby

Pro chyby používáme tyto kódy:

Kód Popis chyby
X000 Překročen maximální limit volání požadavku pro IP adresu.
X001 API klíč aplikace api_app_key nebyl odeslán nebo není platný.
X002 API klíč uživatele api_key nebyl odeslán nebo není platný.
X003 token nebyl odeslán nebo není platný.
X004 Identifikátor hovoru meet_id nebyl odeslán nebo není platný.
X005 Systémová chyba nebo odstávka systému, opakujte požadavek.
X010 Nebyl odeslán nebo neplatný pacient_jmeno.
X011 Neplatný pacient_email.
X012 Neplatný pacient_telefon.
X013 Nebyl odeslán alespoň jeden z povinných pacient_email a pacient_telefon.
X014 Nebyl odeslán nebo neplatný pacient_narozen.
X020 Nebyl odeslán nebo neplatný meet_start.
X021 Začátek hovoru meet_start už byl.
X022 Nelze použít meet_start, protože server je v tomto čase v odstávce (mezi 3:00 a 4:00).
X023 Nelze použít meet_start, protože server je v tomto čase přetížen.
X024 Už existuje jiná pozvánka tohoto uživatele ve stejném meet_start čase.